From 8d3f778c61a1a0a576445e8dc7312613363b787d Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 15 May 2019 13:59:59 -0700 Subject: Add root configuration files --- src/Directory.Build.props | 28 ++++++++++++++++++++++++++ src/Directory.Build.targets | 48 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 src/Directory.Build.props create mode 100644 src/Directory.Build.targets (limited to 'src') diff --git a/src/Directory.Build.props b/src/Directory.Build.props new file mode 100644 index 00000000..a22f4470 --- /dev/null +++ b/src/Directory.Build.props @@ -0,0 +1,28 @@ + + + + + + Debug + false + MSB3246 + + $(MSBuildProjectName) + $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)..\build\)) + $(BaseOutputPath)obj\$(ProjectName)\ + $(BaseOutputPath)$(Configuration)\ + + WiX Toolset Team + WiX Toolset + Copyright (c) .NET Foundation and contributors. All rights reserved. + MS-RL + WiX Toolset + + + + + + diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets new file mode 100644 index 00000000..dac7452a --- /dev/null +++ b/src/Directory.Build.targets @@ -0,0 +1,48 @@ + + + + + + + true + $(SolutionPath) + $(NCrunchOriginalSolutionPath) + + + + + + + $([System.IO.File]::ReadAllText($(TheSolutionPath))) + $([System.IO.Path]::GetDirectoryName( $(TheSolutionPath) )) + (?<="[PackageName]", ")(.*)(?=", ") + + + + + + %(Identity) + $(SolutionFileContent.Contains('\%(Identity).csproj')) + + + + + $(RegexPattern.Replace('[PackageName]','%(PackageName)') ) + $([System.Text.RegularExpressions.Regex]::Match('$(SolutionFileContent)', '%(Pattern)')) + + + + + + + + + + + -- cgit v1.2.3-55-g6feb From 6f6c485118796f044a278447722eaf18ac5bf86e Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 15 May 2019 16:09:26 -0700 Subject: Initial code commit --- WixToolset.Converters.sln | 67 +++ WixToolset.Converters.v3.ncrunchsolution | 6 + appveyor.cmd | 12 + .../ConvertTuplesCommand.cs | 609 +++++++++++++++++++ .../WixToolset.Converters.Tupleizer.csproj | 32 + src/WixToolset.Converters/Wix3Converter.cs | 652 +++++++++++++++++++++ .../WixToolset.Converters.csproj | 26 + src/deps/wix.dll | Bin 0 -> 1753088 bytes .../ConvertTuplesFixture.cs | 391 ++++++++++++ .../TestData/Integration/test.wixout | Bin 0 -> 148559 bytes .../TestData/Integration/test.wixproj | 47 ++ .../TestData/Integration/test.wxs | 36 ++ .../WixToolsetTest.Converters.Tupleizer.csproj | 33 ++ .../WixToolsetTest.Converters/ConverterFixture.cs | 554 +++++++++++++++++ .../Preprocessor/ConvertedPreprocessor.wxs | 62 ++ .../TestData/Preprocessor/Preprocessor.wxs | 63 ++ .../TestData/Preprocessor/wixcop.settings.xml | 9 + .../TestData/QtExec.bad/v3.wxs | 65 ++ .../TestData/QtExec.bad/v4_expected.wxs | 64 ++ .../TestData/QtExec/v3.wxs | 64 ++ .../TestData/QtExec/v4_expected.wxs | 63 ++ .../TestData/SingleFile/ConvertedSingleFile.wxs | 60 ++ .../TestData/SingleFile/SingleFile.wxs | 61 ++ .../WixToolsetTest.Converters.csproj | 39 ++ 24 files changed, 3015 insertions(+) create mode 100644 WixToolset.Converters.v3.ncrunchsolution create mode 100644 appveyor.cmd create mode 100644 src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs create mode 100644 src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj create mode 100644 src/WixToolset.Converters/Wix3Converter.cs create mode 100644 src/WixToolset.Converters/WixToolset.Converters.csproj create mode 100644 src/deps/wix.dll create mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs create mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout create mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj create mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs create mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj create mode 100644 src/test/WixToolsetTest.Converters/ConverterFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs create mode 100644 src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj (limited to 'src') diff --git a/WixToolset.Converters.sln b/WixToolset.Converters.sln index 2f92ebd9..5d26846e 100644 --- a/WixToolset.Converters.sln +++ b/WixToolset.Converters.sln @@ -3,6 +3,16 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 VisualStudioVersion = 15.0.26124.0 MinimumVisualStudioVersion = 15.0.26124.0 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters", "src\WixToolset.Converters\WixToolset.Converters.csproj", "{6FAF6385-6598-4B89-972B-C31AFCA14538}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters.Tupleizer", "src\WixToolset.Converters.Tupleizer\WixToolset.Converters.Tupleizer.csproj", "{F051BCAF-698C-41D5-8427-164537CE5C5C}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters", "src\test\WixToolsetTest.Converters\WixToolsetTest.Converters.csproj", "{485C5038-97E1-4729-A54D-848CC69569FD}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters.Tupleizer", "src\test\WixToolsetTest.Converters.Tupleizer\WixToolsetTest.Converters.Tupleizer.csproj", "{9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -12,7 +22,64 @@ Global Release|x64 = Release|x64 Release|x86 = Release|x86 EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x64.ActiveCfg = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x64.Build.0 = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x86.ActiveCfg = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x86.Build.0 = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|Any CPU.Build.0 = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x64.ActiveCfg = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x64.Build.0 = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x86.ActiveCfg = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x86.Build.0 = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x64.ActiveCfg = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x64.Build.0 = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x86.ActiveCfg = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x86.Build.0 = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|Any CPU.Build.0 = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x64.ActiveCfg = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x64.Build.0 = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x86.ActiveCfg = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x86.Build.0 = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x64.ActiveCfg = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x64.Build.0 = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x86.ActiveCfg = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x86.Build.0 = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|Any CPU.Build.0 = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x64.ActiveCfg = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x64.Build.0 = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x86.ActiveCfg = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x86.Build.0 = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|Any CPU.Build.0 = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x64.ActiveCfg = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x64.Build.0 = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x86.ActiveCfg = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x86.Build.0 = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|Any CPU.ActiveCfg = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|Any CPU.Build.0 = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x64.ActiveCfg = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x64.Build.0 = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x86.ActiveCfg = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C} = {1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E} + {485C5038-97E1-4729-A54D-848CC69569FD} = {1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {2E71F0EC-CF75-44DA-8353-7066EBD06564} + EndGlobalSection EndGlobal diff --git a/WixToolset.Converters.v3.ncrunchsolution b/WixToolset.Converters.v3.ncrunchsolution new file mode 100644 index 00000000..f774ab93 --- /dev/null +++ b/WixToolset.Converters.v3.ncrunchsolution @@ -0,0 +1,6 @@ + + + False + True + + \ No newline at end of file diff --git a/appveyor.cmd b/appveyor.cmd new file mode 100644 index 00000000..7c739df1 --- /dev/null +++ b/appveyor.cmd @@ -0,0 +1,12 @@ +@setlocal +@pushd %~dp0 +@set _P=%~dp0build\Release\publish + +dotnet pack -c Release src\WixToolset.Converters +dotnet pack -c Release src\WixToolset.Converters.Tupleizer + +dotnet build -c Release src\test\WixToolsetTest.Converters +dotnet build -c Release src\test\WixToolsetTest.Converters.Tupleizer + +@popd +@endlocal diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs new file mode 100644 index 00000000..c07dd42e --- /dev/null +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs @@ -0,0 +1,609 @@ +// 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.Converters.Tupleizer +{ + using System; + using System.Linq; + using WixToolset.Data; + using WixToolset.Data.Tuples; + using WixToolset.Data.WindowsInstaller; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + + public class ConvertTuplesCommand + { + public Intermediate Execute(string path) + { + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + return this.Execute(output); + } + + public Intermediate Execute(Wix3.Output output) + { + var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); + + foreach (Wix3.Table table in output.Tables) + { + foreach (Wix3.Row row in table.Rows) + { + var tuple = GenerateTupleFromRow(row); + if (tuple != null) + { + section.Tuples.Add(tuple); + } + } + } + + return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null, embedFilePaths: null); + } + + private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row) + { + var name = row.Table.Name; + switch (name) + { + case "_SummaryInformation": + return DefaultTupleFromRow(typeof(_SummaryInformationTuple), row, columnZeroIsId: false); + case "ActionText": + return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); + case "AdvtExecuteSequence": + return DefaultTupleFromRow(typeof(AdvtExecuteSequenceTuple), row, columnZeroIsId: false); + case "AppId": + return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); + case "AppSearch": + return DefaultTupleFromRow(typeof(AppSearchTuple), row, columnZeroIsId: false); + case "Binary": + return DefaultTupleFromRow(typeof(BinaryTuple), row, columnZeroIsId: false); + case "Class": + return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); + case "CompLocator": + return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: true); + case "Component": + { + var attributes = FieldAsNullableInt(row, 3); + + var location = ComponentLocation.LocalOnly; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) + { + location = ComponentLocation.SourceOnly; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) + { + location = ComponentLocation.Either; + } + + var keyPathType = ComponentKeyPathType.File; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) + { + keyPathType = ComponentKeyPathType.Registry; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) + { + keyPathType = ComponentKeyPathType.OdbcDataSource; + } + + return new ComponentTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentId = FieldAsString(row, 1), + Directory_ = FieldAsString(row, 2), + Condition = FieldAsString(row, 4), + KeyPath = FieldAsString(row, 5), + Location = location, + DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, + NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, + Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, + SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, + Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, + Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, + UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, + Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, + KeyPathType = keyPathType, + }; + } + + case "Condition": + return DefaultTupleFromRow(typeof(ConditionTuple), row, columnZeroIsId: false); + case "CreateFolder": + return DefaultTupleFromRow(typeof(CreateFolderTuple), row, columnZeroIsId: false); + case "CustomAction": + { + var caType = FieldAsInt(row, 1); + var executionType = DetermineCustomActionExecutionType(caType); + var sourceType = DetermineCustomActionSourceType(caType); + var targetType = DetermineCustomActionTargetType(caType); + + return new CustomActionTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ExecutionType = executionType, + SourceType = sourceType, + Source = FieldAsString(row, 2), + TargetType = targetType, + Target = FieldAsString(row, 3), + Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, + TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, + Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, + IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, + Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, + Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, + }; + } + + case "Directory": + return DefaultTupleFromRow(typeof(DirectoryTuple), row, columnZeroIsId: false); + case "DrLocator": + return DefaultTupleFromRow(typeof(DrLocatorTuple), row, columnZeroIsId: false); + case "Error": + return DefaultTupleFromRow(typeof(ErrorTuple), row, columnZeroIsId: false); + case "Extension": + return DefaultTupleFromRow(typeof(ExtensionTuple), row, columnZeroIsId: false); + case "Feature": + { + int attributes = FieldAsInt(row, 7); + var installDefault = FeatureInstallDefault.Local; + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) + { + installDefault = FeatureInstallDefault.FollowParent; + } + else + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) + { + installDefault = FeatureInstallDefault.Source; + } + + return new FeatureTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Feature_Parent = FieldAsString(row, 1), + Title = FieldAsString(row, 2), + Description = FieldAsString(row, 3), + Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), + Level = FieldAsInt(row, 5), + Directory_ = FieldAsString(row, 6), + DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, + DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, + InstallDefault = installDefault, + TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, + }; + } + + case "FeatureComponents": + return DefaultTupleFromRow(typeof(FeatureComponentsTuple), row, columnZeroIsId: false); + case "File": + { + var attributes = FieldAsNullableInt(row, 6); + var readOnly = (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly; + var hidden = (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden; + var system = (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem; + var vital = (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital; + var checksum = (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum; + bool? compressed = null; + if ((attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed) + { + compressed = false; + } + else if ((attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed) + { + compressed = true; + } + + return new FileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Component_ = FieldAsString(row, 1), + LongFileName = FieldAsString(row, 2), + FileSize = FieldAsInt(row, 3), + Version = FieldAsString(row, 4), + Language = FieldAsString(row, 5), + ReadOnly = readOnly, + Hidden = hidden, + System = system, + Vital = vital, + Checksum = checksum, + Compressed = compressed, + }; + } + + case "Font": + return DefaultTupleFromRow(typeof(FontTuple), row, columnZeroIsId: false); + case "Icon": + return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: false); + case "InstallExecuteSequence": + return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); + case "LockPermissions": + return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); + case "Media": + return DefaultTupleFromRow(typeof(MediaTuple), row, columnZeroIsId: false); + case "MIME": + return DefaultTupleFromRow(typeof(MIMETuple), row, columnZeroIsId: false); + case "MoveFile": + return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: false); + case "MsiAssembly": + return DefaultTupleFromRow(typeof(MsiAssemblyTuple), row, columnZeroIsId: false); + case "MsiShortcutProperty": + return DefaultTupleFromRow(typeof(MsiShortcutPropertyTuple), row, columnZeroIsId: false); + case "ProgId": + return DefaultTupleFromRow(typeof(ProgIdTuple), row, columnZeroIsId: false); + case "Property": + return DefaultTupleFromRow(typeof(PropertyTuple), row, columnZeroIsId: false); + case "PublishComponent": + return DefaultTupleFromRow(typeof(PublishComponentTuple), row, columnZeroIsId: false); + case "Registry": + { + var value = FieldAsString(row, 4); + var valueType = RegistryValueType.String; + var valueAction = RegistryValueActionType.Write; + + if (!String.IsNullOrEmpty(value)) + { + if (value.StartsWith("#x", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Binary; + value = value.Substring(2); + } + else if (value.StartsWith("#%", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Expandable; + value = value.Substring(2); + } + else if (value.StartsWith("#", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Integer; + value = value.Substring(1); + } + else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3, value.Length - 6); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Write; + } + else if (value.StartsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Append; + } + else if (value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(0, value.Length - 3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Prepend; + } + } + + return new RegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Value = value, + Component_ = FieldAsString(row, 5), + ValueAction = valueAction, + ValueType = valueType, + }; + } + + case "RegLocator": + return DefaultTupleFromRow(typeof(RegLocatorTuple), row, columnZeroIsId: false); + case "RemoveFile": + return DefaultTupleFromRow(typeof(RemoveFileTuple), row, columnZeroIsId: false); + case "RemoveRegistry": + { + return new RemoveRegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Action = RemoveRegistryActionType.RemoveOnInstall, + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Component_ = FieldAsString(row, 4), + }; + } + + case "ReserveCost": + return DefaultTupleFromRow(typeof(ReserveCostTuple), row, columnZeroIsId: false); + case "ServiceControl": + { + var events = FieldAsInt(row, 2); + var wait = FieldAsNullableInt(row, 4); + return new ServiceControlTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Name = FieldAsString(row, 1), + Arguments = FieldAsString(row, 3), + Wait = !wait.HasValue || wait.Value == 1, + Component_ = FieldAsString(row, 5), + InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, + UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, + InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, + UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, + InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, + UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, + }; + } + + case "ServiceInstall": + return DefaultTupleFromRow(typeof(ServiceInstallTuple), row, columnZeroIsId: true); + case "Shortcut": + return DefaultTupleFromRow(typeof(ShortcutTuple), row, columnZeroIsId: true); + case "Signature": + return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: false); + case "Upgrade": + { + var attributes = FieldAsInt(row, 4); + return new UpgradeTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + UpgradeCode = FieldAsString(row, 0), + VersionMin = FieldAsString(row, 1), + VersionMax = FieldAsString(row, 2), + Language = FieldAsString(row, 3), + Remove = FieldAsString(row, 5), + ActionProperty = FieldAsString(row, 6), + MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, + OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, + IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, + VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, + VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, + ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, + }; + } + + case "Verb": + return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); + //case "WixAction": + // return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) + // { + // SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), FieldAsString(row, 0)), + // Action = FieldAsString(row, 1), + // Condition = FieldAsString(row, 2), + // Sequence = FieldAsInt(row, 3), + // Before = FieldAsString(row, 4), + // After = FieldAsString(row, 5), + // Overridable = FieldAsNullableInt(row, 6) != 0, + // }; + case "WixFile": + var assemblyAttributes3 = FieldAsNullableInt(row, 1); + return new WixFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + AssemblyType = assemblyAttributes3 == 0 ? FileAssemblyType.DotNetAssembly : assemblyAttributes3 == 1 ? FileAssemblyType.Win32Assembly : FileAssemblyType.NotAnAssembly, + File_AssemblyManifest = FieldAsString(row, 2), + File_AssemblyApplication = FieldAsString(row, 3), + Directory_ = FieldAsString(row, 4), + DiskId = FieldAsInt(row, 5), // TODO: BUGBUGBUG: AB#2626: DiskId is nullable in WiX v3. + Source = new IntermediateFieldPathValue() { Path = FieldAsString(row, 6) }, + ProcessorArchitecture = FieldAsString(row, 7), + PatchGroup = FieldAsInt(row, 8), + Attributes = FieldAsInt(row, 9), + }; + case "WixProperty": + { + var attributes = FieldAsInt(row, 1); + return new WixPropertyTuple(SourceLineNumber4(row.SourceLineNumbers)) + { + Property_ = FieldAsString(row, 0), + Admin = (attributes & 0x1) == 0x1, + Hidden = (attributes & 0x2) == 0x2, + Secure = (attributes & 0x4) == 0x4, + }; + } + + default: + return GenericTupleFromCustomRow(row, columnZeroIsId: false); + } + } + + private static CustomActionTargetType DetermineCustomActionTargetType(int type) + { + var targetType = default(CustomActionTargetType); + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) + { + targetType = CustomActionTargetType.VBScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) + { + targetType = CustomActionTargetType.JScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) + { + targetType = CustomActionTargetType.TextData; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) + { + targetType = CustomActionTargetType.Exe; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) + { + targetType = CustomActionTargetType.Dll; + } + + return targetType; + } + + private static CustomActionSourceType DetermineCustomActionSourceType(int type) + { + var sourceType = CustomActionSourceType.Binary; + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) + { + sourceType = CustomActionSourceType.Property; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) + { + sourceType = CustomActionSourceType.Directory; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) + { + sourceType = CustomActionSourceType.File; + } + + return sourceType; + } + + private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) + { + var executionType = CustomActionExecutionType.Immediate; + + if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) + { + executionType = CustomActionExecutionType.Commit; + } + else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) + { + executionType = CustomActionExecutionType.Rollback; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) + { + executionType = CustomActionExecutionType.Deferred; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) + { + executionType = CustomActionExecutionType.ClientRepeat; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) + { + executionType = CustomActionExecutionType.OncePerProcess; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) + { + executionType = CustomActionExecutionType.FirstSequence; + } + + return executionType; + } + + private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) + { + switch (columnType) + { + case Wix3.ColumnType.Number: + return IntermediateFieldType.Number; + case Wix3.ColumnType.Object: + return IntermediateFieldType.Path; + case Wix3.ColumnType.Unknown: + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Preserved: + default: + return IntermediateFieldType.String; + } + } + + private static IntermediateTuple DefaultTupleFromRow(Type tupleType, Wix3.Row row, bool columnZeroIsId) + { + var tuple = Activator.CreateInstance(tupleType) as IntermediateTuple; + + SetTupleFieldsFromRow(row, tuple, columnZeroIsId); + + tuple.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); + return tuple; + } + + private static IntermediateTuple GenericTupleFromCustomRow(Wix3.Row row, bool columnZeroIsId) + { + var columnDefinitions = row.Table.Definition.Columns.Cast(); + var fieldDefinitions = columnDefinitions.Select(columnDefinition => + new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); + var tupleDefinition = new IntermediateTupleDefinition(row.Table.Name, fieldDefinitions, null); + var tuple = new IntermediateTuple(tupleDefinition, SourceLineNumber4(row.SourceLineNumbers)); + + SetTupleFieldsFromRow(row, tuple, columnZeroIsId); + + return tuple; + } + + private static void SetTupleFieldsFromRow(Wix3.Row row, IntermediateTuple tuple, bool columnZeroIsId) + { + int offset = 0; + if (columnZeroIsId) + { + tuple.Id = GetIdentifierForRow(row); + offset = 1; + } + + for (var i = offset; i < row.Fields.Length; ++i) + { + var column = row.Fields[i].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + tuple.Set(i - offset, FieldAsString(row, i)); + break; + case Wix3.ColumnType.Number: + int? nullableValue = FieldAsNullableInt(row, i); + // TODO: Consider whether null values should be coerced to their default value when + // a column is not nullable. For now, just pass through the null. + //int value = FieldAsInt(row, i); + //tuple.Set(i - offset, column.IsNullable ? nullableValue : value); + tuple.Set(i - offset, nullableValue); + break; + case Wix3.ColumnType.Unknown: + break; + } + } + } + + private static Identifier GetIdentifierForRow(Wix3.Row row) + { + var column = row.Fields[0].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); + case Wix3.ColumnType.Number: + return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); + default: + return null; + } + } + + private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) + { + switch (outputType) + { + case Wix3.OutputType.Bundle: + return SectionType.Bundle; + case Wix3.OutputType.Module: + return SectionType.Module; + case Wix3.OutputType.Patch: + return SectionType.Patch; + case Wix3.OutputType.PatchCreation: + return SectionType.PatchCreation; + case Wix3.OutputType.Product: + return SectionType.Product; + case Wix3.OutputType.Transform: + case Wix3.OutputType.Unknown: + default: + return SectionType.Unknown; + } + } + + private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) + { + return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); + } + + private static string FieldAsString(Wix3.Row row, int column) + { + return (string)row[column]; + } + + private static int FieldAsInt(Wix3.Row row, int column) + { + return Convert.ToInt32(row[column]); + } + + private static int? FieldAsNullableInt(Wix3.Row row, int column) + { + var field = row.Fields[column]; + if (field.Data == null) + { + return null; + } + else + { + return Convert.ToInt32(field.Data); + } + } + } +} diff --git a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj new file mode 100644 index 00000000..a162807a --- /dev/null +++ b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj @@ -0,0 +1,32 @@ + + + + + + + netstandard2.0 + Tupleizer + WiX Toolset Converters Tuplizer + embedded + true + + + + NU1701 + + + + + + + + + + + + + + + + + diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs new file mode 100644 index 00000000..c23930b6 --- /dev/null +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -0,0 +1,652 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using System.Globalization; + using System.IO; + using System.Linq; + using System.Text; + using System.Text.RegularExpressions; + using System.Xml; + using System.Xml.Linq; + using WixToolset.Data; + using WixToolset.Extensibility.Services; + + /// + /// WiX source code converter. + /// + public class Wix3Converter + { + private static readonly Regex AddPrefix = new Regex(@"^[^a-zA-Z_]", RegexOptions.Compiled); + private static readonly Regex IllegalIdentifierCharacters = new Regex(@"[^A-Za-z0-9_\.]|\.{2,}", RegexOptions.Compiled); // non 'words' and assorted valid characters + + private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". + private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; + + private static readonly XName DirectoryElementName = WixNamespace + "Directory"; + private static readonly XName FileElementName = WixNamespace + "File"; + private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; + private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; + private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; + private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; + private static readonly XName PayloadElementName = WixNamespace + "Payload"; + private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; + private static readonly XName PropertyElementName = WixNamespace + "Property"; + private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; + + private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() + { + { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, + { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, + { "http://schemas.microsoft.com/wix/DependencyExtension", "http://wixtoolset.org/schemas/v4/wxs/dependency" }, + { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, + { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, + { "http://schemas.microsoft.com/wix/GamingExtension", "http://wixtoolset.org/schemas/v4/wxs/gaming" }, + { "http://schemas.microsoft.com/wix/IIsExtension", "http://wixtoolset.org/schemas/v4/wxs/iis" }, + { "http://schemas.microsoft.com/wix/MsmqExtension", "http://wixtoolset.org/schemas/v4/wxs/msmq" }, + { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, + { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, + { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, + { "http://schemas.microsoft.com/wix/TagExtension", "http://wixtoolset.org/schemas/v4/wxs/tag" }, + { "http://schemas.microsoft.com/wix/UtilExtension", "http://wixtoolset.org/schemas/v4/wxs/util" }, + { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, + { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, + { "http://schemas.microsoft.com/wix/2009/Lux", "http://wixtoolset.org/schemas/v4/lux" }, + { "http://schemas.microsoft.com/wix/2006/wi", "http://wixtoolset.org/schemas/v4/wxs" }, + { "http://schemas.microsoft.com/wix/2006/localization", "http://wixtoolset.org/schemas/v4/wxl" }, + { "http://schemas.microsoft.com/wix/2006/libraries", "http://wixtoolset.org/schemas/v4/wixlib" }, + { "http://schemas.microsoft.com/wix/2006/objects", "http://wixtoolset.org/schemas/v4/wixobj" }, + { "http://schemas.microsoft.com/wix/2006/outputs", "http://wixtoolset.org/schemas/v4/wixout" }, + { "http://schemas.microsoft.com/wix/2007/pdbs", "http://wixtoolset.org/schemas/v4/wixpdb" }, + { "http://schemas.microsoft.com/wix/2003/04/actions", "http://wixtoolset.org/schemas/v4/wi/actions" }, + { "http://schemas.microsoft.com/wix/2006/tables", "http://wixtoolset.org/schemas/v4/wi/tables" }, + { "http://schemas.microsoft.com/wix/2006/WixUnit", "http://wixtoolset.org/schemas/v4/wixunit" }, + }; + + private readonly Dictionary> ConvertElementMapping; + + /// + /// Instantiate a new Converter class. + /// + /// Indentation value to use when validating leading whitespace. + /// Test errors to display as warnings. + /// Test errors to ignore. + public Wix3Converter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null) + { + this.ConvertElementMapping = new Dictionary> + { + { Wix3Converter.DirectoryElementName, this.ConvertDirectoryElement }, + { Wix3Converter.FileElementName, this.ConvertFileElement }, + { Wix3Converter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, + { Wix3Converter.MsiPackageElementName, this.ConvertSuppressSignatureValidation }, + { Wix3Converter.MspPackageElementName, this.ConvertSuppressSignatureValidation }, + { Wix3Converter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, + { Wix3Converter.PayloadElementName, this.ConvertSuppressSignatureValidation }, + { Wix3Converter.CustomActionElementName, this.ConvertCustomActionElement }, + { Wix3Converter.PropertyElementName, this.ConvertPropertyElement }, + { Wix3Converter.WixElementWithoutNamespaceName, this.ConvertWixElementWithoutNamespace }, + }; + + this.Messaging = messaging; + + this.IndentationAmount = indentationAmount; + + this.ErrorsAsWarnings = new HashSet(this.YieldConverterTypes(errorsAsWarnings)); + + this.IgnoreErrors = new HashSet(this.YieldConverterTypes(ignoreErrors)); + } + + private int Errors { get; set; } + + private HashSet ErrorsAsWarnings { get; set; } + + private HashSet IgnoreErrors { get; set; } + + private IMessaging Messaging { get; } + + private int IndentationAmount { get; set; } + + private string SourceFile { get; set; } + + /// + /// Convert a file. + /// + /// The file to convert. + /// Option to save the converted errors that are found. + /// The number of errors found. + public int ConvertFile(string sourceFile, bool saveConvertedFile) + { + XDocument document; + + // Set the instance info. + this.Errors = 0; + this.SourceFile = sourceFile; + + try + { + document = XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + } + catch (XmlException e) + { + this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); + + return this.Errors; + } + + this.ConvertDocument(document); + + // Fix errors if requested and necessary. + if (saveConvertedFile && 0 < this.Errors) + { + try + { + using (var writer = File.CreateText(this.SourceFile)) + { + document.Save(writer, SaveOptions.DisableFormatting | SaveOptions.OmitDuplicateNamespaces); + } + } + catch (UnauthorizedAccessException) + { + this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); + } + } + + return this.Errors; + } + + /// + /// Convert a document. + /// + /// The document to convert. + /// The number of errors found. + public int ConvertDocument(XDocument document) + { + var declaration = document.Declaration; + + // Convert the declaration. + if (null != declaration) + { + if (!String.Equals("utf-8", declaration.Encoding, StringComparison.OrdinalIgnoreCase)) + { + if (this.OnError(ConverterTestType.DeclarationEncodingWrong, document.Root, "The XML declaration encoding is not properly set to 'utf-8'.")) + { + declaration.Encoding = "utf-8"; + } + } + } + else // missing declaration + { + if (this.OnError(ConverterTestType.DeclarationMissing, null, "This file is missing an XML declaration on the first line.")) + { + document.Declaration = new XDeclaration("1.0", "utf-8", null); + document.Root.AddBeforeSelf(new XText(XDocumentNewLine.ToString())); + } + } + + // Start converting the nodes at the top. + this.ConvertNodes(document.Nodes(), 0); + + return this.Errors; + } + + private void ConvertNodes(IEnumerable nodes, int level) + { + // Note we operate on a copy of the node list since we may + // remove some whitespace nodes during this processing. + foreach (var node in nodes.ToList()) + { + if (node is XText text) + { + if (!String.IsNullOrWhiteSpace(text.Value)) + { + text.Value = text.Value.Trim(); + } + else if (node.NextNode is XCData cdata) + { + this.EnsurePrecedingWhitespaceRemoved(text, node, ConverterTestType.WhitespacePrecedingNodeWrong); + } + else if (node.NextNode is XElement element) + { + this.EnsurePrecedingWhitespaceCorrect(text, node, level, ConverterTestType.WhitespacePrecedingNodeWrong); + } + else if (node.NextNode is null) // this is the space before the close element + { + if (node.PreviousNode is null || node.PreviousNode is XCData) + { + this.EnsurePrecedingWhitespaceRemoved(text, node.Parent, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + else if (level == 0) // root element's close tag + { + this.EnsurePrecedingWhitespaceCorrect(text, node, 0, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + else + { + this.EnsurePrecedingWhitespaceCorrect(text, node, level - 1, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + } + } + else if (node is XElement element) + { + this.ConvertElement(element); + + this.ConvertNodes(element.Nodes(), level + 1); + } + } + } + + private void EnsurePrecedingWhitespaceCorrect(XText whitespace, XNode node, int level, ConverterTestType testType) + { + if (!Wix3Converter.LeadingWhitespaceValid(this.IndentationAmount, level, whitespace.Value)) + { + var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; + + if (this.OnError(testType, node, message)) + { + Wix3Converter.FixupWhitespace(this.IndentationAmount, level, whitespace); + } + } + } + + private void EnsurePrecedingWhitespaceRemoved(XText whitespace, XNode node, ConverterTestType testType) + { + if (!String.IsNullOrEmpty(whitespace.Value)) + { + var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; + + if (this.OnError(testType, node, message)) + { + whitespace.Remove(); + } + } + } + + private void ConvertElement(XElement element) + { + // Gather any deprecated namespaces, then update this element tree based on those deprecations. + var deprecatedToUpdatedNamespaces = new Dictionary(); + + foreach (var declaration in element.Attributes().Where(a => a.IsNamespaceDeclaration)) + { + if (Wix3Converter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + { + if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) + { + deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); + } + } + } + + if (deprecatedToUpdatedNamespaces.Any()) + { + Wix3Converter.UpdateElementsWithDeprecatedNamespaces(element.DescendantsAndSelf(), deprecatedToUpdatedNamespaces); + } + + // Apply any specialized conversion actions. + if (this.ConvertElementMapping.TryGetValue(element.Name, out var convert)) + { + convert(element); + } + } + + private void ConvertDirectoryElement(XElement element) + { + if (null == element.Attribute("Name")) + { + var attribute = element.Attribute("ShortName"); + if (null != attribute) + { + var shortName = attribute.Value; + if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) + { + element.Add(new XAttribute("Name", shortName)); + attribute.Remove(); + } + } + } + } + + private void ConvertFileElement(XElement element) + { + if (null == element.Attribute("Id")) + { + var attribute = element.Attribute("Name"); + + if (null == attribute) + { + attribute = element.Attribute("Source"); + } + + if (null != attribute) + { + var name = Path.GetFileName(attribute.Value); + + if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the default", name)) + { + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + element.Add(new XAttribute("Id", GetIdentifierFromName(name))); + element.Add(attributes); + } + } + } + } + + private void ConvertSuppressSignatureValidation(XElement element) + { + var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); + + if (null != suppressSignatureValidation) + { + if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation)) + { + if ("no" == suppressSignatureValidation.Value) + { + element.Add(new XAttribute("EnableSignatureValidation", "yes")); + } + } + + suppressSignatureValidation.Remove(); + } + } + + private void ConvertCustomActionElement(XElement xCustomAction) + { + var xBinaryKey = xCustomAction.Attribute("BinaryKey"); + + if (xBinaryKey?.Value == "WixCA") + { + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'UtilCA' instead.")) + { + xBinaryKey.Value = "UtilCA"; + } + } + + var xDllEntry = xCustomAction.Attribute("DllEntry"); + + if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) + { + xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); + } + } + + var xProperty = xCustomAction.Attribute("Property"); + + if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) + { + xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); + } + } + } + + private void ConvertPropertyElement(XElement xProperty) + { + var xId = xProperty.Attribute("Id"); + + if (xId.Value == "QtExecCmdTimeout") + { + this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); + } + } + + /// + /// Converts a Wix element. + /// + /// The Wix element to convert. + /// The converted element. + private void ConvertWixElementWithoutNamespace(XElement element) + { + if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) + { + element.Name = WixNamespace.GetName(element.Name.LocalName); + + element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. + + foreach (var elementWithoutNamespace in element.Elements().Where(e => XNamespace.None == e.Name.Namespace)) + { + elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); + } + } + } + + private IEnumerable YieldConverterTypes(IEnumerable types) + { + if (null != types) + { + foreach (var type in types) + { + + if (Enum.TryParse(type, true, out var itt)) + { + yield return itt; + } + else // not a known ConverterTestType + { + this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); + } + } + } + } + + private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) + { + foreach (var element in elements) + { + + if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) + { + element.Name = ns.GetName(element.Name.LocalName); + } + + // Remove all the attributes and add them back to with their namespace updated (as necessary). + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + + foreach (var attribute in attributes) + { + var convertedAttribute = attribute; + + if (attribute.IsNamespaceDeclaration) + { + if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) + { + convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); + } + } + else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) + { + convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); + } + + element.Add(convertedAttribute); + } + } + } + + /// + /// Determine if the whitespace preceding a node is appropriate for its depth level. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level that should match this whitespace. + /// The whitespace to validate. + /// true if the whitespace is legal; false otherwise. + private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) + { + // Strip off leading newlines; there can be an arbitrary number of these. + whitespace = whitespace.TrimStart(XDocumentNewLine); + + var indentation = new string(' ', level * indentationAmount); + + return whitespace == indentation; + } + + /// + /// Fix the whitespace in a whitespace node. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level of the desired whitespace. + /// The whitespace node to fix. + private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) + { + var value = new StringBuilder(whitespace.Value.Length); + + // Keep any previous preceeding new lines. + var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); + + // Ensure there is always at least one new line before the indentation. + value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); + + whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); + } + + /// + /// Output an error message to the console. + /// + /// The type of converter test. + /// The node that caused the error. + /// Detailed error message. + /// Additional formatted string arguments. + /// Returns true indicating that action should be taken on this error, and false if it should be ignored. + private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) + { + if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error + { + return false; + } + + // Increase the error count. + this.Errors++; + + var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); + var warning = this.ErrorsAsWarnings.Contains(converterTestType); + var display = String.Format(CultureInfo.CurrentCulture, message, args); + + var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); + + this.Messaging.Write(msg); + + return true; + } + + /// + /// Return an identifier based on passed file/directory name + /// + /// File/directory name to generate identifer from + /// A version of the name that is a legal identifier. + /// This is duplicated from WiX's Common class. + private static string GetIdentifierFromName(string name) + { + string result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + + // MSI identifiers must begin with an alphabetic character or an + // underscore. Prefix all other values with an underscore. + if (AddPrefix.IsMatch(name)) + { + result = String.Concat("_", result); + } + + return result; + } + + /// + /// Converter test types. These are used to condition error messages down to warnings. + /// + private enum ConverterTestType + { + /// + /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. + /// + ConverterTestTypeUnknown, + + /// + /// Displayed when an XML loading exception has occurred. + /// + XmlException, + + /// + /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. + /// + UnauthorizedAccessException, + + /// + /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. + /// + DeclarationEncodingWrong, + + /// + /// Displayed when the XML declaration is missing from the source file. + /// + DeclarationMissing, + + /// + /// Displayed when the whitespace preceding a CDATA node is wrong. + /// + WhitespacePrecedingCDATAWrong, + + /// + /// Displayed when the whitespace preceding a node is wrong. + /// + WhitespacePrecedingNodeWrong, + + /// + /// Displayed when an element is not empty as it should be. + /// + NotEmptyElement, + + /// + /// Displayed when the whitespace following a CDATA node is wrong. + /// + WhitespaceFollowingCDATAWrong, + + /// + /// Displayed when the whitespace preceding an end element is wrong. + /// + WhitespacePrecedingEndElementWrong, + + /// + /// Displayed when the xmlns attribute is missing from the document element. + /// + XmlnsMissing, + + /// + /// Displayed when the xmlns attribute on the document element is wrong. + /// + XmlnsValueWrong, + + /// + /// Assign an identifier to a File element when on Id attribute is specified. + /// + AssignAnonymousFileId, + + /// + /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. + /// + SuppressSignatureValidationDeprecated, + + /// + /// WixCA Binary/@Id has been renamed to UtilCA. + /// + WixCABinaryIdRenamed, + + /// + /// QtExec custom actions have been renamed. + /// + QuietExecCustomActionsRenamed, + + /// + /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. + /// + QtExecCmdTimeoutAmbiguous, + + /// + /// Directory/@ShortName may only be specified with Directory/@Name. + /// + AssignDirectoryNameFromShortName, + } + } +} diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj new file mode 100644 index 00000000..94a956d5 --- /dev/null +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -0,0 +1,26 @@ + + + + + + + netstandard2.0 + Converter + WiX Toolset Converters + embedded + true + + + + NU1701 + + + + + + + + + + + diff --git a/src/deps/wix.dll b/src/deps/wix.dll new file mode 100644 index 00000000..64f70f75 Binary files /dev/null and b/src/deps/wix.dll differ diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs new file mode 100644 index 00000000..ae33d6b1 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs @@ -0,0 +1,391 @@ +// 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 WixToolsetTest.Converters.Tupleizer +{ + using System; + using System.IO; + using System.Linq; + using WixBuildTools.TestSupport; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + using WixToolset.Converters.Tupleizer; + using WixToolset.Data; + using WixToolset.Data.WindowsInstaller; + using WixToolset.Data.Tuples; + using Xunit; + + public class ConvertTuplesFixture + { + [Fact] + public void CanLoadWixoutAndConvertToIntermediate() + { + var rootFolder = TestData.Get(); + var dataFolder = TestData.Get(@"TestData\Integration"); + + using (var fs = new DisposableFileSystem()) + { + var intermediateFolder = fs.GetFolder(); + + var path = Path.Combine(dataFolder, "test.wixout"); + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + + var command = new ConvertTuplesCommand(); + var intermediate = command.Execute(output); + + Assert.NotNull(intermediate); + Assert.Single(intermediate.Sections); + Assert.Equal(String.Empty, intermediate.Id); + + // Save and load to guarantee round-tripping support. + // + var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); + intermediate.Save(wixiplFile); + + intermediate = Intermediate.Load(wixiplFile); + + // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. + // + var tables = output.Tables.Cast(); + var wix3Dump = tables + .SelectMany(table => table.Rows.Cast() + .Select(row => RowToString(row))) + .ToArray(); + + var tuples = intermediate.Sections.SelectMany(s => s.Tuples); + var wix4Dump = tuples.Select(tuple => TupleToString(tuple)).ToArray(); + + Assert.Equal(wix3Dump, wix4Dump); + + // Useful when you want to diff the outputs with another diff tool... + // + //var wix3TextDump = String.Join(Environment.NewLine, wix3Dump.OrderBy(val => val)); + //var wix4TextDump = String.Join(Environment.NewLine, wix4Dump.OrderBy(val => val)); + //Assert.Equal(wix3TextDump, wix4TextDump); + } + } + + private static string RowToString(Wix3.Row row) + { + var fields = String.Join(",", row.Fields.Select(field => field.Data?.ToString())); + + // Massage output to match WiX v3 rows and v4 tuples. + // + switch (row.Table.Name) + { + case "File": + var fieldValues = row.Fields.Take(7).Select(field => field.Data?.ToString()).ToArray(); + if (fieldValues[3] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[3] = "0"; + } + fields = String.Join(",", fieldValues); + break; + case "WixFile": + fields = String.Join(",", row.Fields.Take(8).Select(field => field.Data?.ToString())); + break; + } + + return $"{row.Table.Name},{fields}"; + } + + private static string TupleToString(WixToolset.Data.IntermediateTuple tuple) + { + var fields = String.Join(",", tuple.Fields.Select(field => field?.AsString())); + + switch (tuple.Definition.Name) + { + // Massage output to match WiX v3 rows and v4 tuples. + // + case "Component": + { + var componentTuple = (ComponentTuple)tuple; + var attributes = ComponentLocation.Either == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; + attributes |= ComponentLocation.SourceOnly == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; + attributes |= ComponentKeyPathType.Registry == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; + attributes |= ComponentKeyPathType.OdbcDataSource == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; + attributes |= componentTuple.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; + attributes |= componentTuple.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; + attributes |= componentTuple.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; + attributes |= componentTuple.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; + attributes |= componentTuple.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; + attributes |= componentTuple.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; + attributes |= componentTuple.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + attributes |= componentTuple.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + + fields = String.Join(",", + componentTuple.ComponentId, + componentTuple.Directory_, + attributes.ToString(), + componentTuple.Condition, + componentTuple.KeyPath + ); + break; + } + case "CustomAction": + { + var customActionTuple = (CustomActionTuple)tuple; + var type = customActionTuple.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; + type |= customActionTuple.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; + type |= customActionTuple.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; + type |= customActionTuple.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; + type |= customActionTuple.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; + type |= customActionTuple.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; + type |= CustomActionExecutionType.FirstSequence == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; + type |= CustomActionExecutionType.OncePerProcess == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; + type |= CustomActionExecutionType.ClientRepeat == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; + type |= CustomActionExecutionType.Deferred == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; + type |= CustomActionExecutionType.Rollback == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; + type |= CustomActionExecutionType.Commit == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; + type |= CustomActionSourceType.File == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; + type |= CustomActionSourceType.Directory == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; + type |= CustomActionSourceType.Property == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; + type |= CustomActionTargetType.Dll == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; + type |= CustomActionTargetType.Exe == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; + type |= CustomActionTargetType.TextData == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; + type |= CustomActionTargetType.JScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; + type |= CustomActionTargetType.VBScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; + + fields = String.Join(",", + type.ToString(), + customActionTuple.Source, + customActionTuple.Target, + customActionTuple.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null + ); + break; + } + case "Feature": + { + var featureTuple = (FeatureTuple)tuple; + var attributes = featureTuple.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; + attributes |= featureTuple.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; + attributes |= FeatureInstallDefault.FollowParent == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; + attributes |= FeatureInstallDefault.Source == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; + attributes |= FeatureTypicalDefault.Advertise == featureTuple.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; + + fields = String.Join(",", + featureTuple.Feature_Parent, + featureTuple.Title, + featureTuple.Description, + featureTuple.Display.ToString(), + featureTuple.Level.ToString(), + featureTuple.Directory_, + attributes.ToString()); + break; + } + case "File": + { + var fileTuple = (FileTuple)tuple; + fields = String.Join(",", + fileTuple.Component_, + fileTuple.LongFileName, + fileTuple.FileSize.ToString(), + fileTuple.Version, + fileTuple.Language, + ((fileTuple.ReadOnly ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0) + | (fileTuple.Hidden ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0) + | (fileTuple.System ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0) + | (fileTuple.Vital ? WindowsInstallerConstants.MsidbFileAttributesVital : 0) + | (fileTuple.Checksum ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0) + | ((fileTuple.Compressed.HasValue && fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0) + | ((fileTuple.Compressed.HasValue && !fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0)) + .ToString()); + break; + } + + case "Registry": + { + var registryTuple = (RegistryTuple)tuple; + var value = registryTuple.Value; + + switch (registryTuple.ValueType) + { + case RegistryValueType.Binary: + value = String.Concat("#x", value); + break; + case RegistryValueType.Expandable: + value = String.Concat("#%", value); + break; + case RegistryValueType.Integer: + value = String.Concat("#", value); + break; + case RegistryValueType.MultiString: + switch (registryTuple.ValueAction) + { + case RegistryValueActionType.Append: + value = String.Concat("[~]", value); + break; + case RegistryValueActionType.Prepend: + value = String.Concat(value, "[~]"); + break; + case RegistryValueActionType.Write: + default: + if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) + { + value = String.Concat("[~]", value, "[~]"); + } + break; + } + break; + case RegistryValueType.String: + // escape the leading '#' character for string registry keys + if (null != value && value.StartsWith("#", StringComparison.Ordinal)) + { + value = String.Concat("#", value); + } + break; + } + + fields = String.Join(",", + ((int)registryTuple.Root).ToString(), + registryTuple.Key, + registryTuple.Name, + value, + registryTuple.Component_ + ); + break; + } + + case "RemoveRegistry": + { + var removeRegistryTuple = (RemoveRegistryTuple)tuple; + fields = String.Join(",", + ((int)removeRegistryTuple.Root).ToString(), + removeRegistryTuple.Key, + removeRegistryTuple.Name, + removeRegistryTuple.Component_ + ); + break; + } + + case "ServiceControl": + { + var serviceControlTuple = (ServiceControlTuple)tuple; + + var events = serviceControlTuple.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; + events |= serviceControlTuple.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; + events |= serviceControlTuple.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; + events |= serviceControlTuple.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; + events |= serviceControlTuple.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; + events |= serviceControlTuple.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; + + fields = String.Join(",", + serviceControlTuple.Name, + events.ToString(), + serviceControlTuple.Arguments, + serviceControlTuple.Wait == true ? "1" : "0", + serviceControlTuple.Component_ + ); + break; + } + + case "ServiceInstall": + { + var serviceInstallTuple = (ServiceInstallTuple)tuple; + + var errorControl = (int)serviceInstallTuple.ErrorControl; + errorControl |= serviceInstallTuple.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; + + var serviceType = (int)serviceInstallTuple.ServiceType; + serviceType |= serviceInstallTuple.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; + + fields = String.Join(",", + serviceInstallTuple.Name, + serviceInstallTuple.DisplayName, + serviceType.ToString(), + ((int)serviceInstallTuple.StartType).ToString(), + errorControl.ToString(), + serviceInstallTuple.LoadOrderGroup, + serviceInstallTuple.Dependencies, + serviceInstallTuple.StartName, + serviceInstallTuple.Password, + serviceInstallTuple.Arguments, + serviceInstallTuple.Component_, + serviceInstallTuple.Description + ); + break; + } + + case "Upgrade": + { + var upgradeTuple = (UpgradeTuple)tuple; + + var attributes = upgradeTuple.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; + attributes |= upgradeTuple.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; + attributes |= upgradeTuple.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; + attributes |= upgradeTuple.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; + attributes |= upgradeTuple.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; + attributes |= upgradeTuple.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; + + fields = String.Join(",", + upgradeTuple.VersionMin, + upgradeTuple.VersionMax, + upgradeTuple.Language, + attributes.ToString(), + upgradeTuple.Remove, + upgradeTuple.ActionProperty + ); + break; + } + + case "WixAction": + { + var wixActionTuple = (WixActionTuple)tuple; + fields = String.Join(",", + wixActionTuple.SequenceTable, + wixActionTuple.Action, + wixActionTuple.Condition, + // BUGBUGBUG: AB#2626 + wixActionTuple.Sequence == 0 ? String.Empty : wixActionTuple.Sequence.ToString(), + wixActionTuple.Before, + wixActionTuple.After, + wixActionTuple.Overridable == true ? "1" : "0" + ); + break; + } + + case "WixComplexReference": + { + var wixComplexReferenceTuple = (WixComplexReferenceTuple)tuple; + fields = String.Join(",", + wixComplexReferenceTuple.Parent, + ((int)wixComplexReferenceTuple.ParentType).ToString(), + wixComplexReferenceTuple.ParentLanguage, + wixComplexReferenceTuple.Child, + ((int)wixComplexReferenceTuple.ChildType).ToString(), + wixComplexReferenceTuple.IsPrimary ? "1" : "0" + ); + break; + } + + case "WixFile": + { + var wixFileTuple = (WixFileTuple)tuple; + fields = String.Concat( + wixFileTuple.AssemblyType == FileAssemblyType.DotNetAssembly ? "0" : wixFileTuple.AssemblyType == FileAssemblyType.Win32Assembly ? "1" : String.Empty, ",", + String.Join(",", tuple.Fields.Skip(2).Take(6).Select(field => (string)field).ToArray())); + break; + } + + case "WixProperty": + { + var wixPropertyTuple = (WixPropertyTuple)tuple; + var attributes = 0; + attributes |= wixPropertyTuple.Admin ? 0x1 : 0; + attributes |= wixPropertyTuple.Hidden ? 0x2 : 0; + attributes |= wixPropertyTuple.Secure ? 0x4 : 0; + + fields = String.Join(",", + wixPropertyTuple.Property_, + attributes.ToString() + ); + break; + } + + } + + var id = tuple.Id == null ? String.Empty : String.Concat(",", tuple.Id.Id); + return $"{tuple.Definition.Name}{id},{fields}"; + } + } +} diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout new file mode 100644 index 00000000..da64b8af Binary files /dev/null and b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout differ diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj new file mode 100644 index 00000000..8af13dc8 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj @@ -0,0 +1,47 @@ + + + + Debug + x86 + 3.10 + d59f1c1e-9238-49fa-bfa2-ec1d9c2dda1d + 2.0 + TupleizerWixout + Package + + + bin\$(Configuration)\ + obj\$(Configuration)\ + Debug + + + bin\$(Configuration)\ + obj\$(Configuration)\ + + + + + + + $(WixExtDir)\WixUtilExtension.dll + WixUtilExtension + + + $(WixExtDir)\WixNetFxExtension.dll + WixNetFxExtension + + + + + + + + + \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs new file mode 100644 index 00000000..1006a254 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj b/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj new file mode 100644 index 00000000..fa6a6bcf --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj @@ -0,0 +1,33 @@ + + + + + + + net461 + false + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs new file mode 100644 index 00000000..97769cd6 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -0,0 +1,554 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Text; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + using Xunit; + + public class ConverterFixture + { + private static readonly XNamespace Wix4Namespace = "http://wixtoolset.org/schemas/v4/wxs"; + + [Fact] + public void EnsuresDeclaration() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void EnsuresUtf8Declaration() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 4, null, null); + + var errors = converter.ConvertDocument(document); + + Assert.Equal(1, errors); + Assert.Equal("1.0", document.Declaration.Version); + Assert.Equal("utf-8", document.Declaration.Encoding); + } + + [Fact] + public void CanFixWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 4, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(4, errors); + } + + [Fact] + public void CanPreserveNewLines() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + "", + " ", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + "", + " ", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 4, null, null); + + var conversions = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(3, conversions); + } + + [Fact] + public void CanConvertWithNewLineAtEndOfFile() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + "", + " ", + "", + " ", + "", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + "", + " ", + "", + " ", + "", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 4, null, null); + + var conversions = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(3, conversions); + } + + [Fact] + public void CanFixCdataWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(2, errors); + } + + [Fact] + public void CanFixCdataWithWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(2, errors); + } + + [Fact] + public void CanConvertMainNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + //Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertNamedMainNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); + } + + [Fact] + public void CanConvertNonWixDefaultNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(2, errors); + Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); + Assert.Equal("http://wixtoolset.org/schemas/v4/wxs/util", document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanConvertExtensionNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanConvertMissingNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanConvertAnonymousFile() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertShortNameDirectoryWithoutName() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertSuppressSignatureValidationNo() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertSuppressSignatureValidationYes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + private static string UnformattedDocumentString(XDocument document) + { + var sb = new StringBuilder(); + + using (var writer = new StringWriter(sb)) + { + document.Save(writer, SaveOptions.DisableFormatting); + } + + return sb.ToString(); + } + + private class DummyMessaging : IMessaging + { + public bool EncounteredError { get; set; } + + public int LastErrorNumber { get; set; } + + public bool ShowVerboseMessages { get; set; } + + public bool SuppressAllWarnings { get; set; } + + public bool WarningsAsError { get; set; } + + public void ElevateWarningMessage(int warningNumber) + { + } + + public string FormatMessage(Message message) => String.Empty; + + public void SetListener(IMessageListener listener) + { + } + + public void SuppressWarningMessage(int warningNumber) + { + } + + public void Write(Message message) + { + } + + public void Write(string message, bool verbose = false) + { + } + } + } +} diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs new file mode 100644 index 00000000..dcd43e35 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs new file mode 100644 index 00000000..2eb908c2 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml new file mode 100644 index 00000000..9d3ad496 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs new file mode 100644 index 00000000..b0630f65 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs new file mode 100644 index 00000000..be487147 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs new file mode 100644 index 00000000..8d81a758 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs new file mode 100644 index 00000000..22a961b2 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs new file mode 100644 index 00000000..aacb68fa --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs new file mode 100644 index 00000000..310ae811 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs @@ -0,0 +1,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj new file mode 100644 index 00000000..d16c3d16 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -0,0 +1,39 @@ + + + + + + netcoreapp2.1 + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3-55-g6feb From b645ddc2c1386c1199ca1e7790201d7a5ab6627b Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 22 May 2019 00:54:09 -0700 Subject: Integrate latest changes to tuple definitions --- .../ConvertTuplesCommand.cs | 928 +++++++++++++-------- .../ConvertTuplesFixture.cs | 747 ++++++++++------- 2 files changed, 1020 insertions(+), 655 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs index c07dd42e..007b9c62 100644 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs @@ -3,6 +3,7 @@ namespace WixToolset.Converters.Tupleizer { using System; + using System.Collections.Generic; using System.Linq; using WixToolset.Data; using WixToolset.Data.Tuples; @@ -21,11 +22,17 @@ namespace WixToolset.Converters.Tupleizer { var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + var bindPathsById = IndexById(output, "BindPath"); + var fontsById = IndexById(output, "Font"); + var selfRegById = IndexById(output, "SelfReg"); + var wixDirectoryById = IndexById(output, "WixDirectory"); + foreach (Wix3.Table table in output.Tables) { foreach (Wix3.Row row in table.Rows) { - var tuple = GenerateTupleFromRow(row); + var tuple = GenerateTupleFromRow(row, wixMediaByDiskId, fontsById, bindPathsById, selfRegById, wixDirectoryById); if (tuple != null) { section.Tuples.Add(tuple); @@ -36,353 +43,534 @@ namespace WixToolset.Converters.Tupleizer return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null, embedFilePaths: null); } - private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row) + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add(FieldAsInt(row, 0), row); + } + } + + return wixMediaByDiskId; + } + + private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row + { + var byId = new Dictionary(); + var table = output.Tables[tableName]; + + if (table != null) + { + foreach (T row in table.Rows) + { + byId.Add(FieldAsString(row, 0), row); + } + } + + return byId; + } + + private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixDirectoryById) { var name = row.Table.Name; switch (name) { - case "_SummaryInformation": - return DefaultTupleFromRow(typeof(_SummaryInformationTuple), row, columnZeroIsId: false); - case "ActionText": - return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); - case "AdvtExecuteSequence": - return DefaultTupleFromRow(typeof(AdvtExecuteSequenceTuple), row, columnZeroIsId: false); - case "AppId": - return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); - case "AppSearch": - return DefaultTupleFromRow(typeof(AppSearchTuple), row, columnZeroIsId: false); - case "Binary": - return DefaultTupleFromRow(typeof(BinaryTuple), row, columnZeroIsId: false); - case "Class": - return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); - case "CompLocator": - return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: true); - case "Component": - { - var attributes = FieldAsNullableInt(row, 3); - - var location = ComponentLocation.LocalOnly; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) - { - location = ComponentLocation.SourceOnly; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) - { - location = ComponentLocation.Either; - } + case "_SummaryInformation": + return DefaultTupleFromRow(typeof(SummaryInformationTuple), row, columnZeroIsId: false); + case "ActionText": + return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); + case "AdvtExecuteSequence": + return DefaultTupleFromRow(typeof(AdvtExecuteSequenceTuple), row, columnZeroIsId: false); + case "AppId": + return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); + case "AppSearch": + return DefaultTupleFromRow(typeof(AppSearchTuple), row, columnZeroIsId: false); + case "Billboard": + return DefaultTupleFromRow(typeof(BillboardTuple), row, columnZeroIsId: true); + case "Binary": + return DefaultTupleFromRow(typeof(BinaryTuple), row, columnZeroIsId: true); + case "BindPath": + return null; + case "CCPSearch": + return DefaultTupleFromRow(typeof(CCPSearchTuple), row, columnZeroIsId: true); + case "Class": + return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); + case "CompLocator": + return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: true); + case "Component": + { + var attributes = FieldAsNullableInt(row, 3); - var keyPathType = ComponentKeyPathType.File; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) - { - keyPathType = ComponentKeyPathType.Registry; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) - { - keyPathType = ComponentKeyPathType.OdbcDataSource; - } + var location = ComponentLocation.LocalOnly; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) + { + location = ComponentLocation.SourceOnly; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) + { + location = ComponentLocation.Either; + } - return new ComponentTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentId = FieldAsString(row, 1), - Directory_ = FieldAsString(row, 2), - Condition = FieldAsString(row, 4), - KeyPath = FieldAsString(row, 5), - Location = location, - DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, - NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, - Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, - SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, - Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, - Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, - UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, - Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, - KeyPathType = keyPathType, - }; + var keyPathType = ComponentKeyPathType.File; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) + { + keyPathType = ComponentKeyPathType.Registry; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) + { + keyPathType = ComponentKeyPathType.OdbcDataSource; } - case "Condition": - return DefaultTupleFromRow(typeof(ConditionTuple), row, columnZeroIsId: false); - case "CreateFolder": - return DefaultTupleFromRow(typeof(CreateFolderTuple), row, columnZeroIsId: false); - case "CustomAction": + return new ComponentTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) { - var caType = FieldAsInt(row, 1); - var executionType = DetermineCustomActionExecutionType(caType); - var sourceType = DetermineCustomActionSourceType(caType); - var targetType = DetermineCustomActionTargetType(caType); + ComponentId = FieldAsString(row, 1), + DirectoryRef = FieldAsString(row, 2), + Condition = FieldAsString(row, 4), + KeyPath = FieldAsString(row, 5), + Location = location, + DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, + NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, + Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, + SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, + Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, + Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, + UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, + Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, + KeyPathType = keyPathType, + }; + } - return new CustomActionTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ExecutionType = executionType, - SourceType = sourceType, - Source = FieldAsString(row, 2), - TargetType = targetType, - Target = FieldAsString(row, 3), - Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, - TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, - Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, - IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, - Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, - Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, - }; - } + case "Condition": + return DefaultTupleFromRow(typeof(ConditionTuple), row, columnZeroIsId: false); + case "CreateFolder": + return DefaultTupleFromRow(typeof(CreateFolderTuple), row, columnZeroIsId: false); + case "CustomAction": + { + var caType = FieldAsInt(row, 1); + var executionType = DetermineCustomActionExecutionType(caType); + var sourceType = DetermineCustomActionSourceType(caType); + var targetType = DetermineCustomActionTargetType(caType); - case "Directory": - return DefaultTupleFromRow(typeof(DirectoryTuple), row, columnZeroIsId: false); - case "DrLocator": - return DefaultTupleFromRow(typeof(DrLocatorTuple), row, columnZeroIsId: false); - case "Error": - return DefaultTupleFromRow(typeof(ErrorTuple), row, columnZeroIsId: false); - case "Extension": - return DefaultTupleFromRow(typeof(ExtensionTuple), row, columnZeroIsId: false); - case "Feature": - { - int attributes = FieldAsInt(row, 7); - var installDefault = FeatureInstallDefault.Local; - if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) - { - installDefault = FeatureInstallDefault.FollowParent; - } - else - if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) - { - installDefault = FeatureInstallDefault.Source; - } + return new CustomActionTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ExecutionType = executionType, + SourceType = sourceType, + Source = FieldAsString(row, 2), + TargetType = targetType, + Target = FieldAsString(row, 3), + Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, + TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, + Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, + IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, + Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, + Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, + }; + } - return new FeatureTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Feature_Parent = FieldAsString(row, 1), - Title = FieldAsString(row, 2), - Description = FieldAsString(row, 3), - Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), - Level = FieldAsInt(row, 5), - Directory_ = FieldAsString(row, 6), - DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, - DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, - InstallDefault = installDefault, - TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, - }; + case "Directory": + { + var id = FieldAsString(row, 0); + var splits = SplitDefaultDir(FieldAsString(row, 2)); + + var tuple = new DirectoryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ParentDirectoryRef = FieldAsString(row, 1), + Name = splits[0], + ShortName = splits[1], + SourceName = splits[2], + SourceShortName = splits[3] + }; + + if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) + { + tuple.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); } - case "FeatureComponents": - return DefaultTupleFromRow(typeof(FeatureComponentsTuple), row, columnZeroIsId: false); - case "File": - { - var attributes = FieldAsNullableInt(row, 6); - var readOnly = (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly; - var hidden = (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden; - var system = (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem; - var vital = (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital; - var checksum = (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum; - bool? compressed = null; - if ((attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed) - { - compressed = false; - } - else if ((attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed) - { - compressed = true; - } + return tuple; + } + case "DrLocator": + return DefaultTupleFromRow(typeof(DrLocatorTuple), row, columnZeroIsId: false); + case "DuplicateFile": + return DefaultTupleFromRow(typeof(DuplicateFileTuple), row, columnZeroIsId: true); + case "Error": + return DefaultTupleFromRow(typeof(ErrorTuple), row, columnZeroIsId: false); + case "Extension": + return DefaultTupleFromRow(typeof(ExtensionTuple), row, columnZeroIsId: false); + case "Feature": + { + var attributes = FieldAsInt(row, 7); + var installDefault = FeatureInstallDefault.Local; + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) + { + installDefault = FeatureInstallDefault.FollowParent; + } + else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) + { + installDefault = FeatureInstallDefault.Source; + } - return new FileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Component_ = FieldAsString(row, 1), - LongFileName = FieldAsString(row, 2), - FileSize = FieldAsInt(row, 3), - Version = FieldAsString(row, 4), - Language = FieldAsString(row, 5), - ReadOnly = readOnly, - Hidden = hidden, - System = system, - Vital = vital, - Checksum = checksum, - Compressed = compressed, - }; + return new FeatureTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ParentFeatureRef = FieldAsString(row, 1), + Title = FieldAsString(row, 2), + Description = FieldAsString(row, 3), + Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), + Level = FieldAsInt(row, 5), + DirectoryRef = FieldAsString(row, 6), + DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, + DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, + InstallDefault = installDefault, + TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, + }; + } + + case "FeatureComponents": + return DefaultTupleFromRow(typeof(FeatureComponentsTuple), row, columnZeroIsId: false); + case "File": + { + var attributes = FieldAsNullableInt(row, 6); + var readOnly = (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly; + var hidden = (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden; + var system = (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem; + var vital = (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital; + var checksum = (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum; + bool? compressed = null; + if ((attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed) + { + compressed = false; + } + else if ((attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed) + { + compressed = true; } - case "Font": - return DefaultTupleFromRow(typeof(FontTuple), row, columnZeroIsId: false); - case "Icon": - return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: false); - case "InstallExecuteSequence": - return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); - case "LockPermissions": - return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); - case "Media": - return DefaultTupleFromRow(typeof(MediaTuple), row, columnZeroIsId: false); - case "MIME": - return DefaultTupleFromRow(typeof(MIMETuple), row, columnZeroIsId: false); - case "MoveFile": - return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: false); - case "MsiAssembly": - return DefaultTupleFromRow(typeof(MsiAssemblyTuple), row, columnZeroIsId: false); - case "MsiShortcutProperty": - return DefaultTupleFromRow(typeof(MsiShortcutPropertyTuple), row, columnZeroIsId: false); - case "ProgId": - return DefaultTupleFromRow(typeof(ProgIdTuple), row, columnZeroIsId: false); - case "Property": - return DefaultTupleFromRow(typeof(PropertyTuple), row, columnZeroIsId: false); - case "PublishComponent": - return DefaultTupleFromRow(typeof(PublishComponentTuple), row, columnZeroIsId: false); - case "Registry": - { - var value = FieldAsString(row, 4); - var valueType = RegistryValueType.String; - var valueAction = RegistryValueActionType.Write; - - if (!String.IsNullOrEmpty(value)) - { - if (value.StartsWith("#x", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Binary; - value = value.Substring(2); - } - else if (value.StartsWith("#%", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Expandable; - value = value.Substring(2); - } - else if (value.StartsWith("#", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Integer; - value = value.Substring(1); - } - else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3, value.Length - 6); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Write; - } - else if (value.StartsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Append; - } - else if (value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(0, value.Length - 3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Prepend; - } - } + var id = FieldAsString(row, 0); - return new RegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Value = value, - Component_ = FieldAsString(row, 5), - ValueAction = valueAction, - ValueType = valueType, - }; + var tuple = new FileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ComponentRef = FieldAsString(row, 1), + Name = FieldAsString(row, 2), + FileSize = FieldAsInt(row, 3), + Version = FieldAsString(row, 4), + Language = FieldAsString(row, 5), + ReadOnly = readOnly, + Hidden = hidden, + System = system, + Vital = vital, + Checksum = checksum, + Compressed = compressed, + }; + + if (bindPathsById.TryGetValue(id, out var bindPathRow)) + { + tuple.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; } - case "RegLocator": - return DefaultTupleFromRow(typeof(RegLocatorTuple), row, columnZeroIsId: false); - case "RemoveFile": - return DefaultTupleFromRow(typeof(RemoveFileTuple), row, columnZeroIsId: false); - case "RemoveRegistry": + if (fontsById.TryGetValue(id, out var fontRow)) { - return new RemoveRegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Action = RemoveRegistryActionType.RemoveOnInstall, - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Component_ = FieldAsString(row, 4), - }; + tuple.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; } - case "ReserveCost": - return DefaultTupleFromRow(typeof(ReserveCostTuple), row, columnZeroIsId: false); - case "ServiceControl": + if (selfRegById.TryGetValue(id, out var selfRegRow)) { - var events = FieldAsInt(row, 2); - var wait = FieldAsNullableInt(row, 4); - return new ServiceControlTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Name = FieldAsString(row, 1), - Arguments = FieldAsString(row, 3), - Wait = !wait.HasValue || wait.Value == 1, - Component_ = FieldAsString(row, 5), - InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, - UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, - InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, - UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, - InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, - UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, - }; + tuple.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; } - case "ServiceInstall": - return DefaultTupleFromRow(typeof(ServiceInstallTuple), row, columnZeroIsId: true); - case "Shortcut": - return DefaultTupleFromRow(typeof(ShortcutTuple), row, columnZeroIsId: true); - case "Signature": - return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: false); - case "Upgrade": + return tuple; + } + case "Font": + return null; + case "Icon": + return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: true); + case "InstallExecuteSequence": + return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); + case "LockPermissions": + return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); + case "Media": + { + var diskId = FieldAsInt(row, 0); + var tuple = new MediaTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) { - var attributes = FieldAsInt(row, 4); - return new UpgradeTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - UpgradeCode = FieldAsString(row, 0), - VersionMin = FieldAsString(row, 1), - VersionMax = FieldAsString(row, 2), - Language = FieldAsString(row, 3), - Remove = FieldAsString(row, 5), - ActionProperty = FieldAsString(row, 6), - MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, - OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, - IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, - VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, - VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, - ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, - }; + DiskId = diskId, + LastSequence = FieldAsNullableInt(row, 1), + DiskPrompt = FieldAsString(row, 2), + Cabinet = FieldAsString(row, 3), + VolumeLabel = FieldAsString(row, 4), + Source = FieldAsString(row, 5) + }; + + if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) + { + var compressionLevel = FieldAsString(wixMediaRow, 1); + + tuple.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); + tuple.Layout = wixMediaRow.Layout; } - case "Verb": - return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); - //case "WixAction": - // return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) - // { - // SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), FieldAsString(row, 0)), - // Action = FieldAsString(row, 1), - // Condition = FieldAsString(row, 2), - // Sequence = FieldAsInt(row, 3), - // Before = FieldAsString(row, 4), - // After = FieldAsString(row, 5), - // Overridable = FieldAsNullableInt(row, 6) != 0, - // }; - case "WixFile": - var assemblyAttributes3 = FieldAsNullableInt(row, 1); - return new WixFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return tuple; + } + case "MIME": + return DefaultTupleFromRow(typeof(MIMETuple), row, columnZeroIsId: false); + case "ModuleIgnoreTable": + return DefaultTupleFromRow(typeof(ModuleIgnoreTableTuple), row, columnZeroIsId: true); + case "MoveFile": + return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: true); + case "MsiAssembly": + return DefaultTupleFromRow(typeof(MsiAssemblyTuple), row, columnZeroIsId: false); + case "MsiLockPermissionsEx": + return DefaultTupleFromRow(typeof(MsiLockPermissionsExTuple), row, columnZeroIsId: true); + case "MsiShortcutProperty": + return DefaultTupleFromRow(typeof(MsiShortcutPropertyTuple), row, columnZeroIsId: true); + case "ODBCDataSource": + return DefaultTupleFromRow(typeof(ODBCDataSourceTuple), row, columnZeroIsId: true); + case "ODBCDriver": + return DefaultTupleFromRow(typeof(ODBCDriverTuple), row, columnZeroIsId: true); + case "ODBCTranslator": + return DefaultTupleFromRow(typeof(ODBCTranslatorTuple), row, columnZeroIsId: true); + case "ProgId": + return DefaultTupleFromRow(typeof(ProgIdTuple), row, columnZeroIsId: false); + case "Property": + return DefaultTupleFromRow(typeof(PropertyTuple), row, columnZeroIsId: true); + case "PublishComponent": + return DefaultTupleFromRow(typeof(PublishComponentTuple), row, columnZeroIsId: false); + case "Registry": + { + var value = FieldAsString(row, 4); + var valueType = RegistryValueType.String; + var valueAction = RegistryValueActionType.Write; + + if (!String.IsNullOrEmpty(value)) + { + if (value.StartsWith("#x", StringComparison.Ordinal)) { - AssemblyType = assemblyAttributes3 == 0 ? FileAssemblyType.DotNetAssembly : assemblyAttributes3 == 1 ? FileAssemblyType.Win32Assembly : FileAssemblyType.NotAnAssembly, - File_AssemblyManifest = FieldAsString(row, 2), - File_AssemblyApplication = FieldAsString(row, 3), - Directory_ = FieldAsString(row, 4), - DiskId = FieldAsInt(row, 5), // TODO: BUGBUGBUG: AB#2626: DiskId is nullable in WiX v3. - Source = new IntermediateFieldPathValue() { Path = FieldAsString(row, 6) }, - ProcessorArchitecture = FieldAsString(row, 7), - PatchGroup = FieldAsInt(row, 8), - Attributes = FieldAsInt(row, 9), - }; - case "WixProperty": - { - var attributes = FieldAsInt(row, 1); - return new WixPropertyTuple(SourceLineNumber4(row.SourceLineNumbers)) + valueType = RegistryValueType.Binary; + value = value.Substring(2); + } + else if (value.StartsWith("#%", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Expandable; + value = value.Substring(2); + } + else if (value.StartsWith("#", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Integer; + value = value.Substring(1); + } + else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3, value.Length - 6); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Write; + } + else if (value.StartsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Append; + } + else if (value.EndsWith("[~]", StringComparison.Ordinal)) { - Property_ = FieldAsString(row, 0), - Admin = (attributes & 0x1) == 0x1, - Hidden = (attributes & 0x2) == 0x2, - Secure = (attributes & 0x4) == 0x4, - }; + value = value.Substring(0, value.Length - 3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Prepend; + } } - default: - return GenericTupleFromCustomRow(row, columnZeroIsId: false); + return new RegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Value = value, + ComponentRef = FieldAsString(row, 5), + ValueAction = valueAction, + ValueType = valueType, + }; + } + case "RegLocator": + { + var type = FieldAsInt(row, 4); + + return new RegLocatorTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Type = (RegLocatorType)(type & 0xF), + Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit + }; + } + case "RemoveFile": + { + var installMode = FieldAsInt(row, 4); + return new RemoveFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileName = FieldAsString(row, 2), + DirProperty = FieldAsString(row, 3), + OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, + OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null + }; + } + case "RemoveRegistry": + { + return new RemoveRegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Action = RemoveRegistryActionType.RemoveOnInstall, + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + ComponentRef = FieldAsString(row, 4), + }; + } + + case "ReserveCost": + return DefaultTupleFromRow(typeof(ReserveCostTuple), row, columnZeroIsId: true); + case "SelfReg": + return null; + case "ServiceControl": + { + var events = FieldAsInt(row, 2); + var wait = FieldAsNullableInt(row, 4); + return new ServiceControlTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Name = FieldAsString(row, 1), + Arguments = FieldAsString(row, 3), + Wait = !wait.HasValue || wait.Value == 1, + ComponentRef = FieldAsString(row, 5), + InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, + UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, + InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, + UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, + InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, + UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, + }; + } + + case "ServiceInstall": + return DefaultTupleFromRow(typeof(ServiceInstallTuple), row, columnZeroIsId: true); + case "Shortcut": + { + var splitName = FieldAsString(row, 2).Split('|'); + + return new ShortcutTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + DirectoryRef = FieldAsString(row, 1), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, + ComponentRef = FieldAsString(row, 3), + Target = FieldAsString(row, 4), + Arguments = FieldAsString(row, 5), + Description = FieldAsString(row, 6), + Hotkey = FieldAsNullableInt(row, 7), + IconRef = FieldAsString(row, 8), + IconIndex = FieldAsNullableInt(row, 9), + Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), + WorkingDirectory = FieldAsString(row, 11), + DisplayResourceDll = FieldAsString(row, 12), + DisplayResourceId = FieldAsNullableInt(row, 13), + DescriptionResourceDll = FieldAsString(row, 14), + DescriptionResourceId= FieldAsNullableInt(row, 15), + }; + } + case "Signature": + return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: false); + case "UIText": + return DefaultTupleFromRow(typeof(UITextTuple), row, columnZeroIsId: true); + case "Upgrade": + { + var attributes = FieldAsInt(row, 4); + return new UpgradeTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + UpgradeCode = FieldAsString(row, 0), + VersionMin = FieldAsString(row, 1), + VersionMax = FieldAsString(row, 2), + Language = FieldAsString(row, 3), + Remove = FieldAsString(row, 5), + ActionProperty = FieldAsString(row, 6), + MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, + OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, + IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, + VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, + VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, + ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, + }; + } + case "Verb": + return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); + case "WixAction": + var sequenceTable = FieldAsString(row, 0); + return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) + { + SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), + Action = FieldAsString(row, 1), + Condition = FieldAsString(row, 2), + Sequence = FieldAsNullableInt(row, 3), + Before = FieldAsString(row, 4), + After = FieldAsString(row, 5), + Overridable = FieldAsNullableInt(row, 6) != 0, + }; + case "WixBootstrapperApplication": + return DefaultTupleFromRow(typeof(WixBootstrapperApplicationTuple), row, columnZeroIsId: true); + case "WixBundleContainer": + return DefaultTupleFromRow(typeof(WixBundleContainerTuple), row, columnZeroIsId: true); + case "WixBundleVariable": + return DefaultTupleFromRow(typeof(WixBundleVariableTuple), row, columnZeroIsId: true); + case "WixChainItem": + return DefaultTupleFromRow(typeof(WixChainItemTuple), row, columnZeroIsId: true); + case "WixCustomTable": + return DefaultTupleFromRow(typeof(WixCustomTableTuple), row, columnZeroIsId: true); + case "WixDeltaPatchFile": + return DefaultTupleFromRow(typeof(WixDeltaPatchFileTuple), row, columnZeroIsId: true); + case "WixDirectory": + return null; + case "WixFile": + var assemblyAttributes3 = FieldAsNullableInt(row, 1); + return new WixFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + AssemblyType = assemblyAttributes3 == 0 ? FileAssemblyType.DotNetAssembly : assemblyAttributes3 == 1 ? FileAssemblyType.Win32Assembly : FileAssemblyType.NotAnAssembly, + AssemblyManifestFileRef = FieldAsString(row, 2), + AssemblyApplicationFileRef = FieldAsString(row, 3), + DirectoryRef = FieldAsString(row, 4), + DiskId = FieldAsNullableInt(row, 5) ?? 0, + Source = new IntermediateFieldPathValue() { Path = FieldAsString(row, 6) }, + ProcessorArchitecture = FieldAsString(row, 7), + PatchGroup = FieldAsInt(row, 8), + Attributes = FieldAsInt(row, 9), + PatchAttributes = (PatchAttributeType)FieldAsInt(row, 10), + }; + case "WixInstanceTransforms": + return DefaultTupleFromRow(typeof(WixInstanceTransformsTuple), row, columnZeroIsId: true); + case "WixMedia": + return null; + case "WixMerge": + return DefaultTupleFromRow(typeof(WixMergeTuple), row, columnZeroIsId: true); + case "WixPatchBaseline": + return DefaultTupleFromRow(typeof(WixPatchBaselineTuple), row, columnZeroIsId: true); + case "WixProperty": + { + var attributes = FieldAsInt(row, 1); + return new WixPropertyTuple(SourceLineNumber4(row.SourceLineNumbers)) + { + PropertyRef = FieldAsString(row, 0), + Admin = (attributes & 0x1) == 0x1, + Hidden = (attributes & 0x2) == 0x2, + Secure = (attributes & 0x4) == 0x4, + }; + } + case "WixSuppressModularization": + return DefaultTupleFromRow(typeof(WixSuppressModularizationTuple), row, columnZeroIsId: true); + case "WixUI": + return DefaultTupleFromRow(typeof(WixUITuple), row, columnZeroIsId: true); + case "WixVariable": + return DefaultTupleFromRow(typeof(WixVariableTuple), row, columnZeroIsId: true); + default: + return GenericTupleFromCustomRow(row, columnZeroIsId: false); } } @@ -470,16 +658,16 @@ namespace WixToolset.Converters.Tupleizer { switch (columnType) { - case Wix3.ColumnType.Number: - return IntermediateFieldType.Number; - case Wix3.ColumnType.Object: - return IntermediateFieldType.Path; - case Wix3.ColumnType.Unknown: - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Preserved: - default: - return IntermediateFieldType.String; + case Wix3.ColumnType.Number: + return IntermediateFieldType.Number; + case Wix3.ColumnType.Object: + return IntermediateFieldType.Path; + case Wix3.ColumnType.Unknown: + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Preserved: + default: + return IntermediateFieldType.String; } } @@ -520,22 +708,22 @@ namespace WixToolset.Converters.Tupleizer var column = row.Fields[i].Column; switch (column.Type) { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - tuple.Set(i - offset, FieldAsString(row, i)); - break; - case Wix3.ColumnType.Number: - int? nullableValue = FieldAsNullableInt(row, i); - // TODO: Consider whether null values should be coerced to their default value when - // a column is not nullable. For now, just pass through the null. - //int value = FieldAsInt(row, i); - //tuple.Set(i - offset, column.IsNullable ? nullableValue : value); - tuple.Set(i - offset, nullableValue); + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + tuple.Set(i - offset, FieldAsString(row, i)); + break; + case Wix3.ColumnType.Number: + int? nullableValue = FieldAsNullableInt(row, i); + // TODO: Consider whether null values should be coerced to their default value when + // a column is not nullable. For now, just pass through the null. + //int value = FieldAsInt(row, i); + //tuple.Set(i - offset, column.IsNullable ? nullableValue : value); + tuple.Set(i - offset, nullableValue); + break; + case Wix3.ColumnType.Unknown: break; - case Wix3.ColumnType.Unknown: - break; } } } @@ -545,15 +733,15 @@ namespace WixToolset.Converters.Tupleizer var column = row.Fields[0].Column; switch (column.Type) { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); - case Wix3.ColumnType.Number: - return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); - default: - return null; + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); + case Wix3.ColumnType.Number: + return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); + default: + return null; } } @@ -561,20 +749,20 @@ namespace WixToolset.Converters.Tupleizer { switch (outputType) { - case Wix3.OutputType.Bundle: - return SectionType.Bundle; - case Wix3.OutputType.Module: - return SectionType.Module; - case Wix3.OutputType.Patch: - return SectionType.Patch; - case Wix3.OutputType.PatchCreation: - return SectionType.PatchCreation; - case Wix3.OutputType.Product: - return SectionType.Product; - case Wix3.OutputType.Transform: - case Wix3.OutputType.Unknown: - default: - return SectionType.Unknown; + case Wix3.OutputType.Bundle: + return SectionType.Bundle; + case Wix3.OutputType.Module: + return SectionType.Module; + case Wix3.OutputType.Patch: + return SectionType.Patch; + case Wix3.OutputType.PatchCreation: + return SectionType.PatchCreation; + case Wix3.OutputType.Product: + return SectionType.Product; + case Wix3.OutputType.Transform: + case Wix3.OutputType.Unknown: + default: + return SectionType.Unknown; } } @@ -605,5 +793,19 @@ namespace WixToolset.Converters.Tupleizer return Convert.ToInt32(field.Data); } } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : null, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : null + }; + } } } diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs index ae33d6b1..9b1fa4cf 100644 --- a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs +++ b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs @@ -3,6 +3,7 @@ namespace WixToolsetTest.Converters.Tupleizer { using System; + using System.Collections.Generic; using System.IO; using System.Linq; using WixBuildTools.TestSupport; @@ -42,350 +43,512 @@ namespace WixToolsetTest.Converters.Tupleizer intermediate = Intermediate.Load(wixiplFile); + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. // var tables = output.Tables.Cast(); var wix3Dump = tables .SelectMany(table => table.Rows.Cast() - .Select(row => RowToString(row))) + .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) + .Where(s => !String.IsNullOrEmpty(s)) + .OrderBy(s => s) .ToArray(); var tuples = intermediate.Sections.SelectMany(s => s.Tuples); - var wix4Dump = tuples.Select(tuple => TupleToString(tuple)).ToArray(); + var wix4Dump = tuples + .SelectMany(tuple => TupleToStrings(tuple)) + .OrderBy(s => s) + .ToArray(); +#if false Assert.Equal(wix3Dump, wix4Dump); +#else // useful when you want to diff the outputs with another diff tool. + var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); + var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); - // Useful when you want to diff the outputs with another diff tool... - // - //var wix3TextDump = String.Join(Environment.NewLine, wix3Dump.OrderBy(val => val)); - //var wix4TextDump = String.Join(Environment.NewLine, wix4Dump.OrderBy(val => val)); - //Assert.Equal(wix3TextDump, wix4TextDump); + File.WriteAllText(Path.Combine(Path.GetTempPath(), "~3.txt"), wix3TextDump); + File.WriteAllText(Path.Combine(Path.GetTempPath(), "~4.txt"), wix4TextDump); + + Assert.Equal(wix3TextDump, wix4TextDump); +#endif } } - private static string RowToString(Wix3.Row row) + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) { - var fields = String.Join(",", row.Fields.Select(field => field.Data?.ToString())); + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; - // Massage output to match WiX v3 rows and v4 tuples. - // - switch (row.Table.Name) + if (wixMediaTable != null) { - case "File": - var fieldValues = row.Fields.Take(7).Select(field => field.Data?.ToString()).ToArray(); - if (fieldValues[3] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[3] = "0"; - } - fields = String.Join(",", fieldValues); - break; - case "WixFile": - fields = String.Join(",", row.Fields.Take(8).Select(field => field.Data?.ToString())); - break; + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add((int)row[0], row); + } } - return $"{row.Table.Name},{fields}"; + return wixMediaByDiskId; } - private static string TupleToString(WixToolset.Data.IntermediateTuple tuple) + private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) { - var fields = String.Join(",", tuple.Fields.Select(field => field?.AsString())); + string fields = null; - switch (tuple.Definition.Name) + // Massage output to match WiX v3 rows and v4 tuples. + // + switch (row.Table.Name) { - // Massage output to match WiX v3 rows and v4 tuples. - // - case "Component": - { - var componentTuple = (ComponentTuple)tuple; - var attributes = ComponentLocation.Either == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; - attributes |= ComponentLocation.SourceOnly == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; - attributes |= ComponentKeyPathType.Registry == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; - attributes |= ComponentKeyPathType.OdbcDataSource == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; - attributes |= componentTuple.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; - attributes |= componentTuple.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; - attributes |= componentTuple.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; - attributes |= componentTuple.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; - attributes |= componentTuple.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; - attributes |= componentTuple.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; - attributes |= componentTuple.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - attributes |= componentTuple.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - - fields = String.Join(",", - componentTuple.ComponentId, - componentTuple.Directory_, - attributes.ToString(), - componentTuple.Condition, - componentTuple.KeyPath - ); - break; - } - case "CustomAction": + case "Directory": + var dirs = SplitDefaultDir((string)row[2]); + fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); + break; + case "File": + { + var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); + if (fieldValues[3] == null) { - var customActionTuple = (CustomActionTuple)tuple; - var type = customActionTuple.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; - type |= customActionTuple.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; - type |= customActionTuple.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; - type |= customActionTuple.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; - type |= customActionTuple.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; - type |= customActionTuple.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; - type |= CustomActionExecutionType.FirstSequence == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; - type |= CustomActionExecutionType.OncePerProcess == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; - type |= CustomActionExecutionType.ClientRepeat == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; - type |= CustomActionExecutionType.Deferred == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; - type |= CustomActionExecutionType.Rollback == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; - type |= CustomActionExecutionType.Commit == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; - type |= CustomActionSourceType.File == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; - type |= CustomActionSourceType.Directory == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; - type |= CustomActionSourceType.Property == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; - type |= CustomActionTargetType.Dll == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; - type |= CustomActionTargetType.Exe == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; - type |= CustomActionTargetType.TextData == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; - type |= CustomActionTargetType.JScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; - type |= CustomActionTargetType.VBScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; - - fields = String.Join(",", - type.ToString(), - customActionTuple.Source, - customActionTuple.Target, - customActionTuple.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null - ); - break; + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[3] = "0"; } - case "Feature": - { - var featureTuple = (FeatureTuple)tuple; - var attributes = featureTuple.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; - attributes |= featureTuple.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; - attributes |= FeatureInstallDefault.FollowParent == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; - attributes |= FeatureInstallDefault.Source == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; - attributes |= FeatureTypicalDefault.Advertise == featureTuple.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; - - fields = String.Join(",", - featureTuple.Feature_Parent, - featureTuple.Title, - featureTuple.Description, - featureTuple.Display.ToString(), - featureTuple.Level.ToString(), - featureTuple.Directory_, - attributes.ToString()); - break; - } - case "File": + fields = String.Join(",", fieldValues); + break; + } + case "Media": + var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; + + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); + break; + case "RegLocator": + var type = (int)row[4]; + fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); + break; + case "RemoveFile": + var attributes = (int)row[4]; + var onInstall = (attributes & 1) == 1 ? (bool?)true : null; + var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; + fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); + fields = String.Join(",", fields, onInstall, onUninstall); + break; + case "Shortcut": + var split = ((string)row[2]).Split('|'); + var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); + fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); + break; + case "WixAction": + var table = (int)SequenceStringToSequenceTable(row[0]); + fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); + break; + case "WixFile": + { + var fieldValues = row.Fields.Take(10).Select(SafeConvertField).ToArray(); + if (fieldValues[8] == null) { - var fileTuple = (FileTuple)tuple; - fields = String.Join(",", - fileTuple.Component_, - fileTuple.LongFileName, - fileTuple.FileSize.ToString(), - fileTuple.Version, - fileTuple.Language, - ((fileTuple.ReadOnly ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0) - | (fileTuple.Hidden ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0) - | (fileTuple.System ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0) - | (fileTuple.Vital ? WindowsInstallerConstants.MsidbFileAttributesVital : 0) - | (fileTuple.Checksum ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0) - | ((fileTuple.Compressed.HasValue && fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0) - | ((fileTuple.Compressed.HasValue && !fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0)) - .ToString()); - break; + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[8] = "0"; } + fields = String.Join(",", fieldValues); + break; + } + case "WixMedia": + break; + default: + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + break; + } - case "Registry": - { - var registryTuple = (RegistryTuple)tuple; - var value = registryTuple.Value; - - switch (registryTuple.ValueType) - { - case RegistryValueType.Binary: - value = String.Concat("#x", value); - break; - case RegistryValueType.Expandable: - value = String.Concat("#%", value); - break; - case RegistryValueType.Integer: - value = String.Concat("#", value); - break; - case RegistryValueType.MultiString: - switch (registryTuple.ValueAction) - { - case RegistryValueActionType.Append: - value = String.Concat("[~]", value); - break; - case RegistryValueActionType.Prepend: - value = String.Concat(value, "[~]"); - break; - case RegistryValueActionType.Write: - default: - if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) - { - value = String.Concat("[~]", value, "[~]"); - } - break; - } - break; - case RegistryValueType.String: - // escape the leading '#' character for string registry keys - if (null != value && value.StartsWith("#", StringComparison.Ordinal)) - { - value = String.Concat("#", value); - } - break; - } + if (fields != null) + { + yield return $"{row.Table.Name}:{fields}"; + } + } - fields = String.Join(",", - ((int)registryTuple.Root).ToString(), - registryTuple.Key, - registryTuple.Name, - value, - registryTuple.Component_ - ); - break; - } + private static IEnumerable TupleToStrings(IntermediateTuple tuple) + { + string fields; + switch (tuple.Definition.Name) + { + // Massage output to match WiX v3 rows and v4 tuples. + // + case "Component": + { + var componentTuple = (ComponentTuple)tuple; + var attributes = ComponentLocation.Either == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; + attributes |= ComponentLocation.SourceOnly == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; + attributes |= ComponentKeyPathType.Registry == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; + attributes |= ComponentKeyPathType.OdbcDataSource == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; + attributes |= componentTuple.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; + attributes |= componentTuple.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; + attributes |= componentTuple.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; + attributes |= componentTuple.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; + attributes |= componentTuple.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; + attributes |= componentTuple.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; + attributes |= componentTuple.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + attributes |= componentTuple.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + + fields = String.Join(",", + componentTuple.ComponentId, + componentTuple.DirectoryRef, + attributes.ToString(), + componentTuple.Condition, + componentTuple.KeyPath + ); + break; + } + case "CustomAction": + { + var customActionTuple = (CustomActionTuple)tuple; + var type = customActionTuple.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; + type |= customActionTuple.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; + type |= customActionTuple.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; + type |= customActionTuple.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; + type |= customActionTuple.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; + type |= customActionTuple.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; + type |= CustomActionExecutionType.FirstSequence == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; + type |= CustomActionExecutionType.OncePerProcess == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; + type |= CustomActionExecutionType.ClientRepeat == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; + type |= CustomActionExecutionType.Deferred == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; + type |= CustomActionExecutionType.Rollback == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; + type |= CustomActionExecutionType.Commit == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; + type |= CustomActionSourceType.File == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; + type |= CustomActionSourceType.Directory == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; + type |= CustomActionSourceType.Property == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; + type |= CustomActionTargetType.Dll == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; + type |= CustomActionTargetType.Exe == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; + type |= CustomActionTargetType.TextData == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; + type |= CustomActionTargetType.JScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; + type |= CustomActionTargetType.VBScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; + + fields = String.Join(",", + type.ToString(), + customActionTuple.Source, + customActionTuple.Target, + customActionTuple.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null + ); + break; + } + case "Directory": + { + var directoryTuple = (DirectoryTuple)tuple; - case "RemoveRegistry": + if (!String.IsNullOrEmpty(directoryTuple.ComponentGuidGenerationSeed)) { - var removeRegistryTuple = (RemoveRegistryTuple)tuple; - fields = String.Join(",", - ((int)removeRegistryTuple.Root).ToString(), - removeRegistryTuple.Key, - removeRegistryTuple.Name, - removeRegistryTuple.Component_ - ); - break; + yield return $"WixDirectory:{directoryTuple.Id.Id},{directoryTuple.ComponentGuidGenerationSeed}"; } - case "ServiceControl": - { - var serviceControlTuple = (ServiceControlTuple)tuple; - - var events = serviceControlTuple.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; - events |= serviceControlTuple.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; - events |= serviceControlTuple.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; - events |= serviceControlTuple.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; - events |= serviceControlTuple.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; - events |= serviceControlTuple.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; - - fields = String.Join(",", - serviceControlTuple.Name, - events.ToString(), - serviceControlTuple.Arguments, - serviceControlTuple.Wait == true ? "1" : "0", - serviceControlTuple.Component_ - ); - break; - } + fields = String.Join(",", directoryTuple.ParentDirectoryRef, directoryTuple.Name, directoryTuple.ShortName, directoryTuple.SourceName, directoryTuple.SourceShortName); + break; + } + case "Feature": + { + var featureTuple = (FeatureTuple)tuple; + var attributes = featureTuple.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; + attributes |= featureTuple.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; + attributes |= FeatureInstallDefault.FollowParent == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; + attributes |= FeatureInstallDefault.Source == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; + attributes |= FeatureTypicalDefault.Advertise == featureTuple.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; + + fields = String.Join(",", + featureTuple.ParentFeatureRef, + featureTuple.Title, + featureTuple.Description, + featureTuple.Display.ToString(), + featureTuple.Level.ToString(), + featureTuple.DirectoryRef, + attributes.ToString()); + break; + } + case "File": + { + var fileTuple = (FileTuple)tuple; - case "ServiceInstall": + if (fileTuple.BindPath != null) { - var serviceInstallTuple = (ServiceInstallTuple)tuple; - - var errorControl = (int)serviceInstallTuple.ErrorControl; - errorControl |= serviceInstallTuple.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; - - var serviceType = (int)serviceInstallTuple.ServiceType; - serviceType |= serviceInstallTuple.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; - - fields = String.Join(",", - serviceInstallTuple.Name, - serviceInstallTuple.DisplayName, - serviceType.ToString(), - ((int)serviceInstallTuple.StartType).ToString(), - errorControl.ToString(), - serviceInstallTuple.LoadOrderGroup, - serviceInstallTuple.Dependencies, - serviceInstallTuple.StartName, - serviceInstallTuple.Password, - serviceInstallTuple.Arguments, - serviceInstallTuple.Component_, - serviceInstallTuple.Description - ); - break; + yield return $"BindImage:{fileTuple.Id.Id},{fileTuple.BindPath}"; } - case "Upgrade": + if (fileTuple.FontTitle != null) { - var upgradeTuple = (UpgradeTuple)tuple; - - var attributes = upgradeTuple.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; - attributes |= upgradeTuple.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; - attributes |= upgradeTuple.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; - attributes |= upgradeTuple.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; - attributes |= upgradeTuple.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; - attributes |= upgradeTuple.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; - - fields = String.Join(",", - upgradeTuple.VersionMin, - upgradeTuple.VersionMax, - upgradeTuple.Language, - attributes.ToString(), - upgradeTuple.Remove, - upgradeTuple.ActionProperty - ); - break; + yield return $"Font:{fileTuple.Id.Id},{fileTuple.FontTitle}"; } - case "WixAction": + if (fileTuple.SelfRegCost.HasValue) { - var wixActionTuple = (WixActionTuple)tuple; - fields = String.Join(",", - wixActionTuple.SequenceTable, - wixActionTuple.Action, - wixActionTuple.Condition, - // BUGBUGBUG: AB#2626 - wixActionTuple.Sequence == 0 ? String.Empty : wixActionTuple.Sequence.ToString(), - wixActionTuple.Before, - wixActionTuple.After, - wixActionTuple.Overridable == true ? "1" : "0" - ); - break; + yield return $"SelfReg:{fileTuple.Id.Id},{fileTuple.SelfRegCost}"; } - case "WixComplexReference": - { - var wixComplexReferenceTuple = (WixComplexReferenceTuple)tuple; - fields = String.Join(",", - wixComplexReferenceTuple.Parent, - ((int)wixComplexReferenceTuple.ParentType).ToString(), - wixComplexReferenceTuple.ParentLanguage, - wixComplexReferenceTuple.Child, - ((int)wixComplexReferenceTuple.ChildType).ToString(), - wixComplexReferenceTuple.IsPrimary ? "1" : "0" - ); - break; - } + fields = String.Join(",", + fileTuple.ComponentRef, + fileTuple.Name, + fileTuple.FileSize.ToString(), + fileTuple.Version, + fileTuple.Language, + ((fileTuple.ReadOnly ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0) + | (fileTuple.Hidden ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0) + | (fileTuple.System ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0) + | (fileTuple.Vital ? WindowsInstallerConstants.MsidbFileAttributesVital : 0) + | (fileTuple.Checksum ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0) + | ((fileTuple.Compressed.HasValue && fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0) + | ((fileTuple.Compressed.HasValue && !fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0)) + .ToString()); + break; + } - case "WixFile": - { - var wixFileTuple = (WixFileTuple)tuple; - fields = String.Concat( - wixFileTuple.AssemblyType == FileAssemblyType.DotNetAssembly ? "0" : wixFileTuple.AssemblyType == FileAssemblyType.Win32Assembly ? "1" : String.Empty, ",", - String.Join(",", tuple.Fields.Skip(2).Take(6).Select(field => (string)field).ToArray())); - break; - } + case "Media": + fields = String.Join(",", tuple.Fields.Skip(1).Select(SafeConvertField)); + break; + + case "Registry": + { + var registryTuple = (RegistryTuple)tuple; + var value = registryTuple.Value; - case "WixProperty": + switch (registryTuple.ValueType) { - var wixPropertyTuple = (WixPropertyTuple)tuple; - var attributes = 0; - attributes |= wixPropertyTuple.Admin ? 0x1 : 0; - attributes |= wixPropertyTuple.Hidden ? 0x2 : 0; - attributes |= wixPropertyTuple.Secure ? 0x4 : 0; - - fields = String.Join(",", - wixPropertyTuple.Property_, - attributes.ToString() - ); + case RegistryValueType.Binary: + value = String.Concat("#x", value); + break; + case RegistryValueType.Expandable: + value = String.Concat("#%", value); + break; + case RegistryValueType.Integer: + value = String.Concat("#", value); + break; + case RegistryValueType.MultiString: + switch (registryTuple.ValueAction) + { + case RegistryValueActionType.Append: + value = String.Concat("[~]", value); + break; + case RegistryValueActionType.Prepend: + value = String.Concat(value, "[~]"); + break; + case RegistryValueActionType.Write: + default: + if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) + { + value = String.Concat("[~]", value, "[~]"); + } + break; + } + break; + case RegistryValueType.String: + // escape the leading '#' character for string registry keys + if (null != value && value.StartsWith("#", StringComparison.Ordinal)) + { + value = String.Concat("#", value); + } break; } + fields = String.Join(",", + ((int)registryTuple.Root).ToString(), + registryTuple.Key, + registryTuple.Name, + value, + registryTuple.ComponentRef + ); + break; + } + + case "RemoveRegistry": + { + var removeRegistryTuple = (RemoveRegistryTuple)tuple; + fields = String.Join(",", + ((int)removeRegistryTuple.Root).ToString(), + removeRegistryTuple.Key, + removeRegistryTuple.Name, + removeRegistryTuple.ComponentRef + ); + break; + } + + case "ServiceControl": + { + var serviceControlTuple = (ServiceControlTuple)tuple; + + var events = serviceControlTuple.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; + events |= serviceControlTuple.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; + events |= serviceControlTuple.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; + events |= serviceControlTuple.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; + events |= serviceControlTuple.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; + events |= serviceControlTuple.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; + + fields = String.Join(",", + serviceControlTuple.Name, + events.ToString(), + serviceControlTuple.Arguments, + serviceControlTuple.Wait == true ? "1" : "0", + serviceControlTuple.ComponentRef + ); + break; + } + + case "ServiceInstall": + { + var serviceInstallTuple = (ServiceInstallTuple)tuple; + + var errorControl = (int)serviceInstallTuple.ErrorControl; + errorControl |= serviceInstallTuple.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; + + var serviceType = (int)serviceInstallTuple.ServiceType; + serviceType |= serviceInstallTuple.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; + + fields = String.Join(",", + serviceInstallTuple.Name, + serviceInstallTuple.DisplayName, + serviceType.ToString(), + ((int)serviceInstallTuple.StartType).ToString(), + errorControl.ToString(), + serviceInstallTuple.LoadOrderGroup, + serviceInstallTuple.Dependencies, + serviceInstallTuple.StartName, + serviceInstallTuple.Password, + serviceInstallTuple.Arguments, + serviceInstallTuple.ComponentRef, + serviceInstallTuple.Description + ); + break; + } + + case "Upgrade": + { + var upgradeTuple = (UpgradeTuple)tuple; + + var attributes = upgradeTuple.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; + attributes |= upgradeTuple.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; + attributes |= upgradeTuple.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; + attributes |= upgradeTuple.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; + attributes |= upgradeTuple.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; + attributes |= upgradeTuple.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; + + fields = String.Join(",", + upgradeTuple.VersionMin, + upgradeTuple.VersionMax, + upgradeTuple.Language, + attributes.ToString(), + upgradeTuple.Remove, + upgradeTuple.ActionProperty + ); + break; + } + + case "WixAction": + { + var wixActionTuple = (WixActionTuple)tuple; + var data = wixActionTuple.Fields[(int)WixActionTupleFields.SequenceTable].AsObject(); + var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionTuple.SequenceTable; + + fields = String.Join(",", + sequenceTableAsInt, + wixActionTuple.Action, + wixActionTuple.Condition, + wixActionTuple.Sequence?.ToString() ?? String.Empty, + wixActionTuple.Before, + wixActionTuple.After, + wixActionTuple.Overridable == true ? "1" : "0" + ); + break; + } + + case "WixComplexReference": + { + var wixComplexReferenceTuple = (WixComplexReferenceTuple)tuple; + fields = String.Join(",", + wixComplexReferenceTuple.Parent, + (int)wixComplexReferenceTuple.ParentType, + wixComplexReferenceTuple.ParentLanguage, + wixComplexReferenceTuple.Child, + (int)wixComplexReferenceTuple.ChildType, + wixComplexReferenceTuple.IsPrimary ? "1" : "0" + ); + break; + } + + case "WixFile": + { + var wixFileTuple = (WixFileTuple)tuple; + fields = String.Concat( + wixFileTuple.AssemblyType == FileAssemblyType.DotNetAssembly ? "0" : wixFileTuple.AssemblyType == FileAssemblyType.Win32Assembly ? "1" : String.Empty, ",", + String.Join(",", tuple.Fields.Skip(1).Take(8).Select(field => (string)field))); + break; + } + + case "WixProperty": + { + var wixPropertyTuple = (WixPropertyTuple)tuple; + var attributes = wixPropertyTuple.Admin ? 0x1 : 0; + attributes |= wixPropertyTuple.Hidden ? 0x2 : 0; + attributes |= wixPropertyTuple.Secure ? 0x4 : 0; + + fields = String.Join(",", + wixPropertyTuple.PropertyRef, + attributes.ToString() + ); + break; + } + + default: + fields = String.Join(",", tuple.Fields.Select(SafeConvertField)); + break; + } + + var name = tuple.Definition.Type == TupleDefinitionType.SummaryInformation ? "_SummaryInformation" : tuple.Definition.Name; + var id = tuple.Id?.Id ?? String.Empty; + fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; + yield return $"{name}:{fields}"; + } + + private static SequenceTable SequenceStringToSequenceTable(object sequenceString) + { + switch (sequenceString) + { + case "AdminExecuteSequence": + return SequenceTable.AdminExecuteSequence; + case "AdminUISequence": + return SequenceTable.AdminUISequence; + case "AdvtExecuteSequence": + return SequenceTable.AdvertiseExecuteSequence; + case "InstallExecuteSequence": + return SequenceTable.InstallExecuteSequence; + case "InstallUISequence": + return SequenceTable.InstallUISequence; + default: + throw new ArgumentException($"Unknown sequence: {sequenceString}"); } + } - var id = tuple.Id == null ? String.Empty : String.Concat(",", tuple.Id.Id); - return $"{tuple.Definition.Name}{id},{fields}"; + private static string SafeConvertField(Wix3.Field field) + { + return field?.Data?.ToString(); + } + + private static string SafeConvertField(IntermediateField field) + { + var data = field.AsObject(); + if (data is IntermediateFieldPathValue path) + { + return path.Path; + } + + return data?.ToString(); + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : String.Empty, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty + }; } } } -- cgit v1.2.3-55-g6feb From 5812c6c4b9d40e9ae2b5234a778ecf5aeb8423ff Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Thu, 23 May 2019 15:35:48 -0700 Subject: Integrate latest Data changes for FileTuple and AssemblyTuple --- .../ConvertTuplesCommand.cs | 82 ++++++++++--------- .../ConvertTuplesFixture.cs | 94 ++++++++++++++++------ 2 files changed, 113 insertions(+), 63 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs index 007b9c62..b878f656 100644 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs @@ -23,16 +23,18 @@ namespace WixToolset.Converters.Tupleizer var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + var componentsById = IndexById(output, "Component"); var bindPathsById = IndexById(output, "BindPath"); var fontsById = IndexById(output, "Font"); var selfRegById = IndexById(output, "SelfReg"); var wixDirectoryById = IndexById(output, "WixDirectory"); + var wixFileById = IndexById(output, "WixFile"); foreach (Wix3.Table table in output.Tables) { foreach (Wix3.Row row in table.Rows) { - var tuple = GenerateTupleFromRow(row, wixMediaByDiskId, fontsById, bindPathsById, selfRegById, wixDirectoryById); + var tuple = GenerateTupleFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); if (tuple != null) { section.Tuples.Add(tuple); @@ -75,7 +77,7 @@ namespace WixToolset.Converters.Tupleizer return byId; } - private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixDirectoryById) + private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) { var name = row.Table.Name; switch (name) @@ -234,20 +236,15 @@ namespace WixToolset.Converters.Tupleizer case "File": { var attributes = FieldAsNullableInt(row, 6); - var readOnly = (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly; - var hidden = (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden; - var system = (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem; - var vital = (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital; - var checksum = (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum; - bool? compressed = null; - if ((attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed) - { - compressed = false; - } - else if ((attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed) - { - compressed = true; - } + + FileTupleAttributes tupleAttributes = 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileTupleAttributes.ReadOnly : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileTupleAttributes.Hidden : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileTupleAttributes.System : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileTupleAttributes.Vital : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileTupleAttributes.Checksum : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileTupleAttributes.Uncompressed : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileTupleAttributes.Compressed : 0; var id = FieldAsString(row, 0); @@ -258,12 +255,7 @@ namespace WixToolset.Converters.Tupleizer FileSize = FieldAsInt(row, 3), Version = FieldAsString(row, 4), Language = FieldAsString(row, 5), - ReadOnly = readOnly, - Hidden = hidden, - System = system, - Vital = vital, - Checksum = checksum, - Compressed = compressed, + Attributes = tupleAttributes }; if (bindPathsById.TryGetValue(id, out var bindPathRow)) @@ -281,6 +273,16 @@ namespace WixToolset.Converters.Tupleizer tuple.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; } + if (wixFileById.TryGetValue(id, out var wixFileRow)) + { + tuple.DirectoryRef = FieldAsString(wixFileRow, 4); + tuple.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; + tuple.Source = new IntermediateFieldPathValue() { Path = FieldAsString(wixFileRow, 6) }; + tuple.PatchGroup = FieldAsInt(wixFileRow, 8); + tuple.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileTupleAttributes.GeneratedShortFileName : 0; + tuple.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); + } + return tuple; } case "Font": @@ -321,7 +323,22 @@ namespace WixToolset.Converters.Tupleizer case "MoveFile": return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: true); case "MsiAssembly": - return DefaultTupleFromRow(typeof(MsiAssemblyTuple), row, columnZeroIsId: false); + { + var componentId = FieldAsString(row, 0); + if (componentsById.TryGetValue(componentId, out var componentRow)) + { + return new AssemblyTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) + { + ComponentRef = componentId, + FeatureRef = FieldAsString(row, 1), + ManifestFileRef = FieldAsString(row, 2), + ApplicationFileRef = FieldAsString(row, 3), + Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, + }; + } + + return null; + } case "MsiLockPermissionsEx": return DefaultTupleFromRow(typeof(MsiLockPermissionsExTuple), row, columnZeroIsId: true); case "MsiShortcutProperty": @@ -504,6 +521,7 @@ namespace WixToolset.Converters.Tupleizer case "Verb": return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); case "WixAction": + { var sequenceTable = FieldAsString(row, 0); return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) { @@ -515,6 +533,7 @@ namespace WixToolset.Converters.Tupleizer After = FieldAsString(row, 5), Overridable = FieldAsNullableInt(row, 6) != 0, }; + } case "WixBootstrapperApplication": return DefaultTupleFromRow(typeof(WixBootstrapperApplicationTuple), row, columnZeroIsId: true); case "WixBundleContainer": @@ -525,25 +544,10 @@ namespace WixToolset.Converters.Tupleizer return DefaultTupleFromRow(typeof(WixChainItemTuple), row, columnZeroIsId: true); case "WixCustomTable": return DefaultTupleFromRow(typeof(WixCustomTableTuple), row, columnZeroIsId: true); - case "WixDeltaPatchFile": - return DefaultTupleFromRow(typeof(WixDeltaPatchFileTuple), row, columnZeroIsId: true); case "WixDirectory": return null; case "WixFile": - var assemblyAttributes3 = FieldAsNullableInt(row, 1); - return new WixFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - AssemblyType = assemblyAttributes3 == 0 ? FileAssemblyType.DotNetAssembly : assemblyAttributes3 == 1 ? FileAssemblyType.Win32Assembly : FileAssemblyType.NotAnAssembly, - AssemblyManifestFileRef = FieldAsString(row, 2), - AssemblyApplicationFileRef = FieldAsString(row, 3), - DirectoryRef = FieldAsString(row, 4), - DiskId = FieldAsNullableInt(row, 5) ?? 0, - Source = new IntermediateFieldPathValue() { Path = FieldAsString(row, 6) }, - ProcessorArchitecture = FieldAsString(row, 7), - PatchGroup = FieldAsInt(row, 8), - Attributes = FieldAsInt(row, 9), - PatchAttributes = (PatchAttributeType)FieldAsInt(row, 10), - }; + return null; case "WixInstanceTransforms": return DefaultTupleFromRow(typeof(WixInstanceTransformsTuple), row, columnZeroIsId: true); case "WixMedia": diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs index 9b1fa4cf..14ebd70a 100644 --- a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs +++ b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs @@ -56,8 +56,11 @@ namespace WixToolsetTest.Converters.Tupleizer .ToArray(); var tuples = intermediate.Sections.SelectMany(s => s.Tuples); + + var assemblyTuplesByFileId = tuples.OfType().ToDictionary(a => a.Id.Id); + var wix4Dump = tuples - .SelectMany(tuple => TupleToStrings(tuple)) + .SelectMany(tuple => TupleToStrings(tuple, assemblyTuplesByFileId)) .OrderBy(s => s) .ToArray(); @@ -67,8 +70,11 @@ namespace WixToolsetTest.Converters.Tupleizer var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); - File.WriteAllText(Path.Combine(Path.GetTempPath(), "~3.txt"), wix3TextDump); - File.WriteAllText(Path.Combine(Path.GetTempPath(), "~4.txt"), wix4TextDump); + var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); + var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); + + File.WriteAllText(path3, wix3TextDump); + File.WriteAllText(path4, wix4TextDump); Assert.Equal(wix3TextDump, wix4TextDump); #endif @@ -143,13 +149,19 @@ namespace WixToolsetTest.Converters.Tupleizer break; case "WixFile": { - var fieldValues = row.Fields.Take(10).Select(SafeConvertField).ToArray(); + var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); if (fieldValues[8] == null) { // "Somebody" sometimes writes out a null field even when the column definition says // it's non-nullable. Not naming names or anything. (SWID tags.) fieldValues[8] = "0"; } + if (fieldValues[10] == null) + { + // WixFile rows that come from merge modules will not have the attributes column set + // so initilaize with 0. + fieldValues[10] = "0"; + } fields = String.Join(",", fieldValues); break; } @@ -166,8 +178,11 @@ namespace WixToolsetTest.Converters.Tupleizer } } - private static IEnumerable TupleToStrings(IntermediateTuple tuple) + private static IEnumerable TupleToStrings(IntermediateTuple tuple, Dictionary assemblyTuplesByFileId) { + var name = tuple.Definition.Type == TupleDefinitionType.SummaryInformation ? "_SummaryInformation" : tuple.Definition.Name; + var id = tuple.Id?.Id ?? String.Empty; + string fields; switch (tuple.Definition.Name) { @@ -280,20 +295,53 @@ namespace WixToolsetTest.Converters.Tupleizer yield return $"SelfReg:{fileTuple.Id.Id},{fileTuple.SelfRegCost}"; } + int? assemblyAttributes = null; + if (assemblyTuplesByFileId.TryGetValue(fileTuple.Id.Id, out var assemblyTuple)) + { + if (assemblyTuple.Type == AssemblyType.DotNetAssembly) + { + assemblyAttributes = 0; + } + else if (assemblyTuple.Type == AssemblyType.Win32Assembly) + { + assemblyAttributes = 1; + } + } + + yield return "WixFile:" + String.Join(",", + fileTuple.Id.Id, + assemblyAttributes, + assemblyTuple?.ManifestFileRef, + assemblyTuple?.ApplicationFileRef, + fileTuple.DirectoryRef, + fileTuple.DiskId, + fileTuple.Source.Path, + null, // assembly processor arch + fileTuple.PatchGroup, + (fileTuple.Attributes & FileTupleAttributes.GeneratedShortFileName) != 0 ? 1 : 0, + (int)fileTuple.PatchAttributes, + fileTuple.RetainLengths, + fileTuple.IgnoreOffsets, + fileTuple.IgnoreLengths, + fileTuple.RetainOffsets + ); + + var fileAttributes = 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; + fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; + fields = String.Join(",", fileTuple.ComponentRef, fileTuple.Name, fileTuple.FileSize.ToString(), fileTuple.Version, fileTuple.Language, - ((fileTuple.ReadOnly ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0) - | (fileTuple.Hidden ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0) - | (fileTuple.System ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0) - | (fileTuple.Vital ? WindowsInstallerConstants.MsidbFileAttributesVital : 0) - | (fileTuple.Checksum ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0) - | ((fileTuple.Compressed.HasValue && fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0) - | ((fileTuple.Compressed.HasValue && !fileTuple.Compressed.Value) ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0)) - .ToString()); + fileAttributes); break; } @@ -301,6 +349,15 @@ namespace WixToolsetTest.Converters.Tupleizer fields = String.Join(",", tuple.Fields.Skip(1).Select(SafeConvertField)); break; + case "Assembly": + { + var assemblyTuple = (AssemblyTuple)tuple; + + id = null; + name = "MsiAssembly"; + fields = String.Join(",", assemblyTuple.ComponentRef, assemblyTuple.FeatureRef, assemblyTuple.ManifestFileRef, assemblyTuple.ApplicationFileRef, assemblyTuple.Type == AssemblyType.Win32Assembly ? 1 : 0); + break; + } case "Registry": { var registryTuple = (RegistryTuple)tuple; @@ -468,15 +525,6 @@ namespace WixToolsetTest.Converters.Tupleizer break; } - case "WixFile": - { - var wixFileTuple = (WixFileTuple)tuple; - fields = String.Concat( - wixFileTuple.AssemblyType == FileAssemblyType.DotNetAssembly ? "0" : wixFileTuple.AssemblyType == FileAssemblyType.Win32Assembly ? "1" : String.Empty, ",", - String.Join(",", tuple.Fields.Skip(1).Take(8).Select(field => (string)field))); - break; - } - case "WixProperty": { var wixPropertyTuple = (WixPropertyTuple)tuple; @@ -496,8 +544,6 @@ namespace WixToolsetTest.Converters.Tupleizer break; } - var name = tuple.Definition.Type == TupleDefinitionType.SummaryInformation ? "_SummaryInformation" : tuple.Definition.Name; - var id = tuple.Id?.Id ?? String.Empty; fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; yield return $"{name}:{fields}"; } -- cgit v1.2.3-55-g6feb From a056927970ba5453462143e61a62c2bc19d61c91 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Mon, 24 Jun 2019 14:43:21 -0700 Subject: Normalize RegLocator correctly --- .../WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'src') diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs index 14ebd70a..a180e20d 100644 --- a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs +++ b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs @@ -358,6 +358,13 @@ namespace WixToolsetTest.Converters.Tupleizer fields = String.Join(",", assemblyTuple.ComponentRef, assemblyTuple.FeatureRef, assemblyTuple.ManifestFileRef, assemblyTuple.ApplicationFileRef, assemblyTuple.Type == AssemblyType.Win32Assembly ? 1 : 0); break; } + case "RegLocator": + { + var locatorTuple = (RegLocatorTuple)tuple; + + fields = String.Join(",", (int)locatorTuple.Root, locatorTuple.Key, locatorTuple.Name, (int)locatorTuple.Type, locatorTuple.Win64); + break; + } case "Registry": { var registryTuple = (RegistryTuple)tuple; -- cgit v1.2.3-55-g6feb From c950d39509e67705a660227df5a03bb77ed7b578 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Tue, 25 Jun 2019 18:52:09 -0400 Subject: Fix keypath bug and overload resolution oddity. - Ensure a component with directory keypath is accurately reflected in `ComponentTuple.KeyPathType`. - To ensure callers don't have to reference wix.dll, have separate static methods for converting a file or a live WiX v3 `Output` object. --- .../ConvertTuples.cs | 816 +++++++++++++++++++++ .../ConvertTuplesCommand.cs | 815 -------------------- .../ConvertTuplesFixture.cs | 5 +- 3 files changed, 818 insertions(+), 818 deletions(-) create mode 100644 src/WixToolset.Converters.Tupleizer/ConvertTuples.cs delete mode 100644 src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs new file mode 100644 index 00000000..88fe0575 --- /dev/null +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs @@ -0,0 +1,816 @@ +// 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.Converters.Tupleizer +{ + using System; + using System.Collections.Generic; + using System.Linq; + using WixToolset.Data; + using WixToolset.Data.Tuples; + using WixToolset.Data.WindowsInstaller; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + + public static class ConvertTuples + { + public static Intermediate ConvertFile(string path) + { + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + return ConvertOutput(output); + } + + public static Intermediate ConvertOutput(Wix3.Output output) + { + var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); + + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + var componentsById = IndexById(output, "Component"); + var bindPathsById = IndexById(output, "BindPath"); + var fontsById = IndexById(output, "Font"); + var selfRegById = IndexById(output, "SelfReg"); + var wixDirectoryById = IndexById(output, "WixDirectory"); + var wixFileById = IndexById(output, "WixFile"); + + foreach (Wix3.Table table in output.Tables) + { + foreach (Wix3.Row row in table.Rows) + { + var tuple = GenerateTupleFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); + if (tuple != null) + { + section.Tuples.Add(tuple); + } + } + } + + return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null, embedFilePaths: null); + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add(FieldAsInt(row, 0), row); + } + } + + return wixMediaByDiskId; + } + + private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row + { + var byId = new Dictionary(); + var table = output.Tables[tableName]; + + if (table != null) + { + foreach (T row in table.Rows) + { + byId.Add(FieldAsString(row, 0), row); + } + } + + return byId; + } + + private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) + { + var name = row.Table.Name; + switch (name) + { + case "_SummaryInformation": + return DefaultTupleFromRow(typeof(SummaryInformationTuple), row, columnZeroIsId: false); + case "ActionText": + return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); + case "AdvtExecuteSequence": + return DefaultTupleFromRow(typeof(AdvtExecuteSequenceTuple), row, columnZeroIsId: false); + case "AppId": + return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); + case "AppSearch": + return DefaultTupleFromRow(typeof(AppSearchTuple), row, columnZeroIsId: false); + case "Billboard": + return DefaultTupleFromRow(typeof(BillboardTuple), row, columnZeroIsId: true); + case "Binary": + return DefaultTupleFromRow(typeof(BinaryTuple), row, columnZeroIsId: true); + case "BindPath": + return null; + case "CCPSearch": + return DefaultTupleFromRow(typeof(CCPSearchTuple), row, columnZeroIsId: true); + case "Class": + return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); + case "CompLocator": + return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: true); + case "Component": + { + var attributes = FieldAsNullableInt(row, 3); + + var location = ComponentLocation.LocalOnly; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) + { + location = ComponentLocation.SourceOnly; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) + { + location = ComponentLocation.Either; + } + + var keyPath = FieldAsString(row, 5); + var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) + { + keyPathType = ComponentKeyPathType.Registry; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) + { + keyPathType = ComponentKeyPathType.OdbcDataSource; + } + + return new ComponentTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentId = FieldAsString(row, 1), + DirectoryRef = FieldAsString(row, 2), + Condition = FieldAsString(row, 4), + KeyPath = keyPath, + Location = location, + DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, + NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, + Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, + SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, + Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, + Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, + UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, + Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, + KeyPathType = keyPathType, + }; + } + + case "Condition": + return DefaultTupleFromRow(typeof(ConditionTuple), row, columnZeroIsId: false); + case "CreateFolder": + return DefaultTupleFromRow(typeof(CreateFolderTuple), row, columnZeroIsId: false); + case "CustomAction": + { + var caType = FieldAsInt(row, 1); + var executionType = DetermineCustomActionExecutionType(caType); + var sourceType = DetermineCustomActionSourceType(caType); + var targetType = DetermineCustomActionTargetType(caType); + + return new CustomActionTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ExecutionType = executionType, + SourceType = sourceType, + Source = FieldAsString(row, 2), + TargetType = targetType, + Target = FieldAsString(row, 3), + Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, + TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, + Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, + IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, + Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, + Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, + }; + } + + case "Directory": + { + var id = FieldAsString(row, 0); + var splits = SplitDefaultDir(FieldAsString(row, 2)); + + var tuple = new DirectoryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ParentDirectoryRef = FieldAsString(row, 1), + Name = splits[0], + ShortName = splits[1], + SourceName = splits[2], + SourceShortName = splits[3] + }; + + if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) + { + tuple.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); + } + + return tuple; + } + case "DrLocator": + return DefaultTupleFromRow(typeof(DrLocatorTuple), row, columnZeroIsId: false); + case "DuplicateFile": + return DefaultTupleFromRow(typeof(DuplicateFileTuple), row, columnZeroIsId: true); + case "Error": + return DefaultTupleFromRow(typeof(ErrorTuple), row, columnZeroIsId: false); + case "Extension": + return DefaultTupleFromRow(typeof(ExtensionTuple), row, columnZeroIsId: false); + case "Feature": + { + var attributes = FieldAsInt(row, 7); + var installDefault = FeatureInstallDefault.Local; + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) + { + installDefault = FeatureInstallDefault.FollowParent; + } + else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) + { + installDefault = FeatureInstallDefault.Source; + } + + return new FeatureTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ParentFeatureRef = FieldAsString(row, 1), + Title = FieldAsString(row, 2), + Description = FieldAsString(row, 3), + Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), + Level = FieldAsInt(row, 5), + DirectoryRef = FieldAsString(row, 6), + DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, + DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, + InstallDefault = installDefault, + TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, + }; + } + + case "FeatureComponents": + return DefaultTupleFromRow(typeof(FeatureComponentsTuple), row, columnZeroIsId: false); + case "File": + { + var attributes = FieldAsNullableInt(row, 6); + + FileTupleAttributes tupleAttributes = 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileTupleAttributes.ReadOnly : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileTupleAttributes.Hidden : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileTupleAttributes.System : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileTupleAttributes.Vital : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileTupleAttributes.Checksum : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileTupleAttributes.Uncompressed : 0; + tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileTupleAttributes.Compressed : 0; + + var id = FieldAsString(row, 0); + + var tuple = new FileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ComponentRef = FieldAsString(row, 1), + Name = FieldAsString(row, 2), + FileSize = FieldAsInt(row, 3), + Version = FieldAsString(row, 4), + Language = FieldAsString(row, 5), + Attributes = tupleAttributes + }; + + if (bindPathsById.TryGetValue(id, out var bindPathRow)) + { + tuple.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; + } + + if (fontsById.TryGetValue(id, out var fontRow)) + { + tuple.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; + } + + if (selfRegById.TryGetValue(id, out var selfRegRow)) + { + tuple.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; + } + + if (wixFileById.TryGetValue(id, out var wixFileRow)) + { + tuple.DirectoryRef = FieldAsString(wixFileRow, 4); + tuple.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; + tuple.Source = new IntermediateFieldPathValue() { Path = FieldAsString(wixFileRow, 6) }; + tuple.PatchGroup = FieldAsInt(wixFileRow, 8); + tuple.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileTupleAttributes.GeneratedShortFileName : 0; + tuple.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); + } + + return tuple; + } + case "Font": + return null; + case "Icon": + return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: true); + case "InstallExecuteSequence": + return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); + case "LockPermissions": + return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); + case "Media": + { + var diskId = FieldAsInt(row, 0); + var tuple = new MediaTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) + { + DiskId = diskId, + LastSequence = FieldAsNullableInt(row, 1), + DiskPrompt = FieldAsString(row, 2), + Cabinet = FieldAsString(row, 3), + VolumeLabel = FieldAsString(row, 4), + Source = FieldAsString(row, 5) + }; + + if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) + { + var compressionLevel = FieldAsString(wixMediaRow, 1); + + tuple.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); + tuple.Layout = wixMediaRow.Layout; + } + + return tuple; + } + case "MIME": + return DefaultTupleFromRow(typeof(MIMETuple), row, columnZeroIsId: false); + case "ModuleIgnoreTable": + return DefaultTupleFromRow(typeof(ModuleIgnoreTableTuple), row, columnZeroIsId: true); + case "MoveFile": + return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: true); + case "MsiAssembly": + { + var componentId = FieldAsString(row, 0); + if (componentsById.TryGetValue(componentId, out var componentRow)) + { + return new AssemblyTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) + { + ComponentRef = componentId, + FeatureRef = FieldAsString(row, 1), + ManifestFileRef = FieldAsString(row, 2), + ApplicationFileRef = FieldAsString(row, 3), + Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, + }; + } + + return null; + } + case "MsiLockPermissionsEx": + return DefaultTupleFromRow(typeof(MsiLockPermissionsExTuple), row, columnZeroIsId: true); + case "MsiShortcutProperty": + return DefaultTupleFromRow(typeof(MsiShortcutPropertyTuple), row, columnZeroIsId: true); + case "ODBCDataSource": + return DefaultTupleFromRow(typeof(ODBCDataSourceTuple), row, columnZeroIsId: true); + case "ODBCDriver": + return DefaultTupleFromRow(typeof(ODBCDriverTuple), row, columnZeroIsId: true); + case "ODBCTranslator": + return DefaultTupleFromRow(typeof(ODBCTranslatorTuple), row, columnZeroIsId: true); + case "ProgId": + return DefaultTupleFromRow(typeof(ProgIdTuple), row, columnZeroIsId: false); + case "Property": + return DefaultTupleFromRow(typeof(PropertyTuple), row, columnZeroIsId: true); + case "PublishComponent": + return DefaultTupleFromRow(typeof(PublishComponentTuple), row, columnZeroIsId: false); + case "Registry": + { + var value = FieldAsString(row, 4); + var valueType = RegistryValueType.String; + var valueAction = RegistryValueActionType.Write; + + if (!String.IsNullOrEmpty(value)) + { + if (value.StartsWith("#x", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Binary; + value = value.Substring(2); + } + else if (value.StartsWith("#%", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Expandable; + value = value.Substring(2); + } + else if (value.StartsWith("#", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Integer; + value = value.Substring(1); + } + else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3, value.Length - 6); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Write; + } + else if (value.StartsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Append; + } + else if (value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(0, value.Length - 3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Prepend; + } + } + + return new RegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Value = value, + ComponentRef = FieldAsString(row, 5), + ValueAction = valueAction, + ValueType = valueType, + }; + } + case "RegLocator": + { + var type = FieldAsInt(row, 4); + + return new RegLocatorTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Type = (RegLocatorType)(type & 0xF), + Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit + }; + } + case "RemoveFile": + { + var installMode = FieldAsInt(row, 4); + return new RemoveFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileName = FieldAsString(row, 2), + DirProperty = FieldAsString(row, 3), + OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, + OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null + }; + } + case "RemoveRegistry": + { + return new RemoveRegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Action = RemoveRegistryActionType.RemoveOnInstall, + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + ComponentRef = FieldAsString(row, 4), + }; + } + + case "ReserveCost": + return DefaultTupleFromRow(typeof(ReserveCostTuple), row, columnZeroIsId: true); + case "SelfReg": + return null; + case "ServiceControl": + { + var events = FieldAsInt(row, 2); + var wait = FieldAsNullableInt(row, 4); + return new ServiceControlTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Name = FieldAsString(row, 1), + Arguments = FieldAsString(row, 3), + Wait = !wait.HasValue || wait.Value == 1, + ComponentRef = FieldAsString(row, 5), + InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, + UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, + InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, + UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, + InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, + UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, + }; + } + + case "ServiceInstall": + return DefaultTupleFromRow(typeof(ServiceInstallTuple), row, columnZeroIsId: true); + case "Shortcut": + { + var splitName = FieldAsString(row, 2).Split('|'); + + return new ShortcutTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + DirectoryRef = FieldAsString(row, 1), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, + ComponentRef = FieldAsString(row, 3), + Target = FieldAsString(row, 4), + Arguments = FieldAsString(row, 5), + Description = FieldAsString(row, 6), + Hotkey = FieldAsNullableInt(row, 7), + IconRef = FieldAsString(row, 8), + IconIndex = FieldAsNullableInt(row, 9), + Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), + WorkingDirectory = FieldAsString(row, 11), + DisplayResourceDll = FieldAsString(row, 12), + DisplayResourceId = FieldAsNullableInt(row, 13), + DescriptionResourceDll = FieldAsString(row, 14), + DescriptionResourceId= FieldAsNullableInt(row, 15), + }; + } + case "Signature": + return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: false); + case "UIText": + return DefaultTupleFromRow(typeof(UITextTuple), row, columnZeroIsId: true); + case "Upgrade": + { + var attributes = FieldAsInt(row, 4); + return new UpgradeTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + UpgradeCode = FieldAsString(row, 0), + VersionMin = FieldAsString(row, 1), + VersionMax = FieldAsString(row, 2), + Language = FieldAsString(row, 3), + Remove = FieldAsString(row, 5), + ActionProperty = FieldAsString(row, 6), + MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, + OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, + IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, + VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, + VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, + ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, + }; + } + case "Verb": + return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); + case "WixAction": + { + var sequenceTable = FieldAsString(row, 0); + return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) + { + SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), + Action = FieldAsString(row, 1), + Condition = FieldAsString(row, 2), + Sequence = FieldAsNullableInt(row, 3), + Before = FieldAsString(row, 4), + After = FieldAsString(row, 5), + Overridable = FieldAsNullableInt(row, 6) != 0, + }; + } + case "WixBootstrapperApplication": + return DefaultTupleFromRow(typeof(WixBootstrapperApplicationTuple), row, columnZeroIsId: true); + case "WixBundleContainer": + return DefaultTupleFromRow(typeof(WixBundleContainerTuple), row, columnZeroIsId: true); + case "WixBundleVariable": + return DefaultTupleFromRow(typeof(WixBundleVariableTuple), row, columnZeroIsId: true); + case "WixChainItem": + return DefaultTupleFromRow(typeof(WixChainItemTuple), row, columnZeroIsId: true); + case "WixCustomTable": + return DefaultTupleFromRow(typeof(WixCustomTableTuple), row, columnZeroIsId: true); + case "WixDirectory": + return null; + case "WixFile": + return null; + case "WixInstanceTransforms": + return DefaultTupleFromRow(typeof(WixInstanceTransformsTuple), row, columnZeroIsId: true); + case "WixMedia": + return null; + case "WixMerge": + return DefaultTupleFromRow(typeof(WixMergeTuple), row, columnZeroIsId: true); + case "WixPatchBaseline": + return DefaultTupleFromRow(typeof(WixPatchBaselineTuple), row, columnZeroIsId: true); + case "WixProperty": + { + var attributes = FieldAsInt(row, 1); + return new WixPropertyTuple(SourceLineNumber4(row.SourceLineNumbers)) + { + PropertyRef = FieldAsString(row, 0), + Admin = (attributes & 0x1) == 0x1, + Hidden = (attributes & 0x2) == 0x2, + Secure = (attributes & 0x4) == 0x4, + }; + } + case "WixSuppressModularization": + return DefaultTupleFromRow(typeof(WixSuppressModularizationTuple), row, columnZeroIsId: true); + case "WixUI": + return DefaultTupleFromRow(typeof(WixUITuple), row, columnZeroIsId: true); + case "WixVariable": + return DefaultTupleFromRow(typeof(WixVariableTuple), row, columnZeroIsId: true); + default: + return GenericTupleFromCustomRow(row, columnZeroIsId: false); + } + } + + private static CustomActionTargetType DetermineCustomActionTargetType(int type) + { + var targetType = default(CustomActionTargetType); + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) + { + targetType = CustomActionTargetType.VBScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) + { + targetType = CustomActionTargetType.JScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) + { + targetType = CustomActionTargetType.TextData; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) + { + targetType = CustomActionTargetType.Exe; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) + { + targetType = CustomActionTargetType.Dll; + } + + return targetType; + } + + private static CustomActionSourceType DetermineCustomActionSourceType(int type) + { + var sourceType = CustomActionSourceType.Binary; + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) + { + sourceType = CustomActionSourceType.Property; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) + { + sourceType = CustomActionSourceType.Directory; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) + { + sourceType = CustomActionSourceType.File; + } + + return sourceType; + } + + private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) + { + var executionType = CustomActionExecutionType.Immediate; + + if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) + { + executionType = CustomActionExecutionType.Commit; + } + else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) + { + executionType = CustomActionExecutionType.Rollback; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) + { + executionType = CustomActionExecutionType.Deferred; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) + { + executionType = CustomActionExecutionType.ClientRepeat; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) + { + executionType = CustomActionExecutionType.OncePerProcess; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) + { + executionType = CustomActionExecutionType.FirstSequence; + } + + return executionType; + } + + private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) + { + switch (columnType) + { + case Wix3.ColumnType.Number: + return IntermediateFieldType.Number; + case Wix3.ColumnType.Object: + return IntermediateFieldType.Path; + case Wix3.ColumnType.Unknown: + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Preserved: + default: + return IntermediateFieldType.String; + } + } + + private static IntermediateTuple DefaultTupleFromRow(Type tupleType, Wix3.Row row, bool columnZeroIsId) + { + var tuple = Activator.CreateInstance(tupleType) as IntermediateTuple; + + SetTupleFieldsFromRow(row, tuple, columnZeroIsId); + + tuple.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); + return tuple; + } + + private static IntermediateTuple GenericTupleFromCustomRow(Wix3.Row row, bool columnZeroIsId) + { + var columnDefinitions = row.Table.Definition.Columns.Cast(); + var fieldDefinitions = columnDefinitions.Select(columnDefinition => + new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); + var tupleDefinition = new IntermediateTupleDefinition(row.Table.Name, fieldDefinitions, null); + var tuple = new IntermediateTuple(tupleDefinition, SourceLineNumber4(row.SourceLineNumbers)); + + SetTupleFieldsFromRow(row, tuple, columnZeroIsId); + + return tuple; + } + + private static void SetTupleFieldsFromRow(Wix3.Row row, IntermediateTuple tuple, bool columnZeroIsId) + { + int offset = 0; + if (columnZeroIsId) + { + tuple.Id = GetIdentifierForRow(row); + offset = 1; + } + + for (var i = offset; i < row.Fields.Length; ++i) + { + var column = row.Fields[i].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + tuple.Set(i - offset, FieldAsString(row, i)); + break; + case Wix3.ColumnType.Number: + int? nullableValue = FieldAsNullableInt(row, i); + // TODO: Consider whether null values should be coerced to their default value when + // a column is not nullable. For now, just pass through the null. + //int value = FieldAsInt(row, i); + //tuple.Set(i - offset, column.IsNullable ? nullableValue : value); + tuple.Set(i - offset, nullableValue); + break; + case Wix3.ColumnType.Unknown: + break; + } + } + } + + private static Identifier GetIdentifierForRow(Wix3.Row row) + { + var column = row.Fields[0].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); + case Wix3.ColumnType.Number: + return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); + default: + return null; + } + } + + private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) + { + switch (outputType) + { + case Wix3.OutputType.Bundle: + return SectionType.Bundle; + case Wix3.OutputType.Module: + return SectionType.Module; + case Wix3.OutputType.Patch: + return SectionType.Patch; + case Wix3.OutputType.PatchCreation: + return SectionType.PatchCreation; + case Wix3.OutputType.Product: + return SectionType.Product; + case Wix3.OutputType.Transform: + case Wix3.OutputType.Unknown: + default: + return SectionType.Unknown; + } + } + + private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) + { + return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); + } + + private static string FieldAsString(Wix3.Row row, int column) + { + return (string)row[column]; + } + + private static int FieldAsInt(Wix3.Row row, int column) + { + return Convert.ToInt32(row[column]); + } + + private static int? FieldAsNullableInt(Wix3.Row row, int column) + { + var field = row.Fields[column]; + if (field.Data == null) + { + return null; + } + else + { + return Convert.ToInt32(field.Data); + } + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : null, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : null + }; + } + } +} diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs deleted file mode 100644 index b878f656..00000000 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuplesCommand.cs +++ /dev/null @@ -1,815 +0,0 @@ -// 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.Converters.Tupleizer -{ - using System; - using System.Collections.Generic; - using System.Linq; - using WixToolset.Data; - using WixToolset.Data.Tuples; - using WixToolset.Data.WindowsInstaller; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - - public class ConvertTuplesCommand - { - public Intermediate Execute(string path) - { - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - return this.Execute(output); - } - - public Intermediate Execute(Wix3.Output output) - { - var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); - - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - var componentsById = IndexById(output, "Component"); - var bindPathsById = IndexById(output, "BindPath"); - var fontsById = IndexById(output, "Font"); - var selfRegById = IndexById(output, "SelfReg"); - var wixDirectoryById = IndexById(output, "WixDirectory"); - var wixFileById = IndexById(output, "WixFile"); - - foreach (Wix3.Table table in output.Tables) - { - foreach (Wix3.Row row in table.Rows) - { - var tuple = GenerateTupleFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); - if (tuple != null) - { - section.Tuples.Add(tuple); - } - } - } - - return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null, embedFilePaths: null); - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add(FieldAsInt(row, 0), row); - } - } - - return wixMediaByDiskId; - } - - private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row - { - var byId = new Dictionary(); - var table = output.Tables[tableName]; - - if (table != null) - { - foreach (T row in table.Rows) - { - byId.Add(FieldAsString(row, 0), row); - } - } - - return byId; - } - - private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) - { - var name = row.Table.Name; - switch (name) - { - case "_SummaryInformation": - return DefaultTupleFromRow(typeof(SummaryInformationTuple), row, columnZeroIsId: false); - case "ActionText": - return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); - case "AdvtExecuteSequence": - return DefaultTupleFromRow(typeof(AdvtExecuteSequenceTuple), row, columnZeroIsId: false); - case "AppId": - return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); - case "AppSearch": - return DefaultTupleFromRow(typeof(AppSearchTuple), row, columnZeroIsId: false); - case "Billboard": - return DefaultTupleFromRow(typeof(BillboardTuple), row, columnZeroIsId: true); - case "Binary": - return DefaultTupleFromRow(typeof(BinaryTuple), row, columnZeroIsId: true); - case "BindPath": - return null; - case "CCPSearch": - return DefaultTupleFromRow(typeof(CCPSearchTuple), row, columnZeroIsId: true); - case "Class": - return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); - case "CompLocator": - return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: true); - case "Component": - { - var attributes = FieldAsNullableInt(row, 3); - - var location = ComponentLocation.LocalOnly; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) - { - location = ComponentLocation.SourceOnly; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) - { - location = ComponentLocation.Either; - } - - var keyPathType = ComponentKeyPathType.File; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) - { - keyPathType = ComponentKeyPathType.Registry; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) - { - keyPathType = ComponentKeyPathType.OdbcDataSource; - } - - return new ComponentTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentId = FieldAsString(row, 1), - DirectoryRef = FieldAsString(row, 2), - Condition = FieldAsString(row, 4), - KeyPath = FieldAsString(row, 5), - Location = location, - DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, - NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, - Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, - SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, - Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, - Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, - UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, - Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, - KeyPathType = keyPathType, - }; - } - - case "Condition": - return DefaultTupleFromRow(typeof(ConditionTuple), row, columnZeroIsId: false); - case "CreateFolder": - return DefaultTupleFromRow(typeof(CreateFolderTuple), row, columnZeroIsId: false); - case "CustomAction": - { - var caType = FieldAsInt(row, 1); - var executionType = DetermineCustomActionExecutionType(caType); - var sourceType = DetermineCustomActionSourceType(caType); - var targetType = DetermineCustomActionTargetType(caType); - - return new CustomActionTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ExecutionType = executionType, - SourceType = sourceType, - Source = FieldAsString(row, 2), - TargetType = targetType, - Target = FieldAsString(row, 3), - Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, - TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, - Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, - IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, - Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, - Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, - }; - } - - case "Directory": - { - var id = FieldAsString(row, 0); - var splits = SplitDefaultDir(FieldAsString(row, 2)); - - var tuple = new DirectoryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) - { - ParentDirectoryRef = FieldAsString(row, 1), - Name = splits[0], - ShortName = splits[1], - SourceName = splits[2], - SourceShortName = splits[3] - }; - - if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) - { - tuple.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); - } - - return tuple; - } - case "DrLocator": - return DefaultTupleFromRow(typeof(DrLocatorTuple), row, columnZeroIsId: false); - case "DuplicateFile": - return DefaultTupleFromRow(typeof(DuplicateFileTuple), row, columnZeroIsId: true); - case "Error": - return DefaultTupleFromRow(typeof(ErrorTuple), row, columnZeroIsId: false); - case "Extension": - return DefaultTupleFromRow(typeof(ExtensionTuple), row, columnZeroIsId: false); - case "Feature": - { - var attributes = FieldAsInt(row, 7); - var installDefault = FeatureInstallDefault.Local; - if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) - { - installDefault = FeatureInstallDefault.FollowParent; - } - else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) - { - installDefault = FeatureInstallDefault.Source; - } - - return new FeatureTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ParentFeatureRef = FieldAsString(row, 1), - Title = FieldAsString(row, 2), - Description = FieldAsString(row, 3), - Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), - Level = FieldAsInt(row, 5), - DirectoryRef = FieldAsString(row, 6), - DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, - DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, - InstallDefault = installDefault, - TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, - }; - } - - case "FeatureComponents": - return DefaultTupleFromRow(typeof(FeatureComponentsTuple), row, columnZeroIsId: false); - case "File": - { - var attributes = FieldAsNullableInt(row, 6); - - FileTupleAttributes tupleAttributes = 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileTupleAttributes.ReadOnly : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileTupleAttributes.Hidden : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileTupleAttributes.System : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileTupleAttributes.Vital : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileTupleAttributes.Checksum : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileTupleAttributes.Uncompressed : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileTupleAttributes.Compressed : 0; - - var id = FieldAsString(row, 0); - - var tuple = new FileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) - { - ComponentRef = FieldAsString(row, 1), - Name = FieldAsString(row, 2), - FileSize = FieldAsInt(row, 3), - Version = FieldAsString(row, 4), - Language = FieldAsString(row, 5), - Attributes = tupleAttributes - }; - - if (bindPathsById.TryGetValue(id, out var bindPathRow)) - { - tuple.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; - } - - if (fontsById.TryGetValue(id, out var fontRow)) - { - tuple.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; - } - - if (selfRegById.TryGetValue(id, out var selfRegRow)) - { - tuple.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; - } - - if (wixFileById.TryGetValue(id, out var wixFileRow)) - { - tuple.DirectoryRef = FieldAsString(wixFileRow, 4); - tuple.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; - tuple.Source = new IntermediateFieldPathValue() { Path = FieldAsString(wixFileRow, 6) }; - tuple.PatchGroup = FieldAsInt(wixFileRow, 8); - tuple.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileTupleAttributes.GeneratedShortFileName : 0; - tuple.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); - } - - return tuple; - } - case "Font": - return null; - case "Icon": - return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: true); - case "InstallExecuteSequence": - return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); - case "LockPermissions": - return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); - case "Media": - { - var diskId = FieldAsInt(row, 0); - var tuple = new MediaTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) - { - DiskId = diskId, - LastSequence = FieldAsNullableInt(row, 1), - DiskPrompt = FieldAsString(row, 2), - Cabinet = FieldAsString(row, 3), - VolumeLabel = FieldAsString(row, 4), - Source = FieldAsString(row, 5) - }; - - if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) - { - var compressionLevel = FieldAsString(wixMediaRow, 1); - - tuple.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); - tuple.Layout = wixMediaRow.Layout; - } - - return tuple; - } - case "MIME": - return DefaultTupleFromRow(typeof(MIMETuple), row, columnZeroIsId: false); - case "ModuleIgnoreTable": - return DefaultTupleFromRow(typeof(ModuleIgnoreTableTuple), row, columnZeroIsId: true); - case "MoveFile": - return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: true); - case "MsiAssembly": - { - var componentId = FieldAsString(row, 0); - if (componentsById.TryGetValue(componentId, out var componentRow)) - { - return new AssemblyTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) - { - ComponentRef = componentId, - FeatureRef = FieldAsString(row, 1), - ManifestFileRef = FieldAsString(row, 2), - ApplicationFileRef = FieldAsString(row, 3), - Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, - }; - } - - return null; - } - case "MsiLockPermissionsEx": - return DefaultTupleFromRow(typeof(MsiLockPermissionsExTuple), row, columnZeroIsId: true); - case "MsiShortcutProperty": - return DefaultTupleFromRow(typeof(MsiShortcutPropertyTuple), row, columnZeroIsId: true); - case "ODBCDataSource": - return DefaultTupleFromRow(typeof(ODBCDataSourceTuple), row, columnZeroIsId: true); - case "ODBCDriver": - return DefaultTupleFromRow(typeof(ODBCDriverTuple), row, columnZeroIsId: true); - case "ODBCTranslator": - return DefaultTupleFromRow(typeof(ODBCTranslatorTuple), row, columnZeroIsId: true); - case "ProgId": - return DefaultTupleFromRow(typeof(ProgIdTuple), row, columnZeroIsId: false); - case "Property": - return DefaultTupleFromRow(typeof(PropertyTuple), row, columnZeroIsId: true); - case "PublishComponent": - return DefaultTupleFromRow(typeof(PublishComponentTuple), row, columnZeroIsId: false); - case "Registry": - { - var value = FieldAsString(row, 4); - var valueType = RegistryValueType.String; - var valueAction = RegistryValueActionType.Write; - - if (!String.IsNullOrEmpty(value)) - { - if (value.StartsWith("#x", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Binary; - value = value.Substring(2); - } - else if (value.StartsWith("#%", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Expandable; - value = value.Substring(2); - } - else if (value.StartsWith("#", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Integer; - value = value.Substring(1); - } - else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3, value.Length - 6); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Write; - } - else if (value.StartsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Append; - } - else if (value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(0, value.Length - 3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Prepend; - } - } - - return new RegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Value = value, - ComponentRef = FieldAsString(row, 5), - ValueAction = valueAction, - ValueType = valueType, - }; - } - case "RegLocator": - { - var type = FieldAsInt(row, 4); - - return new RegLocatorTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Type = (RegLocatorType)(type & 0xF), - Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit - }; - } - case "RemoveFile": - { - var installMode = FieldAsInt(row, 4); - return new RemoveFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentRef = FieldAsString(row, 1), - FileName = FieldAsString(row, 2), - DirProperty = FieldAsString(row, 3), - OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, - OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null - }; - } - case "RemoveRegistry": - { - return new RemoveRegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Action = RemoveRegistryActionType.RemoveOnInstall, - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - ComponentRef = FieldAsString(row, 4), - }; - } - - case "ReserveCost": - return DefaultTupleFromRow(typeof(ReserveCostTuple), row, columnZeroIsId: true); - case "SelfReg": - return null; - case "ServiceControl": - { - var events = FieldAsInt(row, 2); - var wait = FieldAsNullableInt(row, 4); - return new ServiceControlTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Name = FieldAsString(row, 1), - Arguments = FieldAsString(row, 3), - Wait = !wait.HasValue || wait.Value == 1, - ComponentRef = FieldAsString(row, 5), - InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, - UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, - InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, - UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, - InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, - UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, - }; - } - - case "ServiceInstall": - return DefaultTupleFromRow(typeof(ServiceInstallTuple), row, columnZeroIsId: true); - case "Shortcut": - { - var splitName = FieldAsString(row, 2).Split('|'); - - return new ShortcutTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - DirectoryRef = FieldAsString(row, 1), - Name = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortName = splitName.Length > 1 ? splitName[0] : null, - ComponentRef = FieldAsString(row, 3), - Target = FieldAsString(row, 4), - Arguments = FieldAsString(row, 5), - Description = FieldAsString(row, 6), - Hotkey = FieldAsNullableInt(row, 7), - IconRef = FieldAsString(row, 8), - IconIndex = FieldAsNullableInt(row, 9), - Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), - WorkingDirectory = FieldAsString(row, 11), - DisplayResourceDll = FieldAsString(row, 12), - DisplayResourceId = FieldAsNullableInt(row, 13), - DescriptionResourceDll = FieldAsString(row, 14), - DescriptionResourceId= FieldAsNullableInt(row, 15), - }; - } - case "Signature": - return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: false); - case "UIText": - return DefaultTupleFromRow(typeof(UITextTuple), row, columnZeroIsId: true); - case "Upgrade": - { - var attributes = FieldAsInt(row, 4); - return new UpgradeTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - UpgradeCode = FieldAsString(row, 0), - VersionMin = FieldAsString(row, 1), - VersionMax = FieldAsString(row, 2), - Language = FieldAsString(row, 3), - Remove = FieldAsString(row, 5), - ActionProperty = FieldAsString(row, 6), - MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, - OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, - IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, - VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, - VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, - ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, - }; - } - case "Verb": - return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); - case "WixAction": - { - var sequenceTable = FieldAsString(row, 0); - return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) - { - SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), - Action = FieldAsString(row, 1), - Condition = FieldAsString(row, 2), - Sequence = FieldAsNullableInt(row, 3), - Before = FieldAsString(row, 4), - After = FieldAsString(row, 5), - Overridable = FieldAsNullableInt(row, 6) != 0, - }; - } - case "WixBootstrapperApplication": - return DefaultTupleFromRow(typeof(WixBootstrapperApplicationTuple), row, columnZeroIsId: true); - case "WixBundleContainer": - return DefaultTupleFromRow(typeof(WixBundleContainerTuple), row, columnZeroIsId: true); - case "WixBundleVariable": - return DefaultTupleFromRow(typeof(WixBundleVariableTuple), row, columnZeroIsId: true); - case "WixChainItem": - return DefaultTupleFromRow(typeof(WixChainItemTuple), row, columnZeroIsId: true); - case "WixCustomTable": - return DefaultTupleFromRow(typeof(WixCustomTableTuple), row, columnZeroIsId: true); - case "WixDirectory": - return null; - case "WixFile": - return null; - case "WixInstanceTransforms": - return DefaultTupleFromRow(typeof(WixInstanceTransformsTuple), row, columnZeroIsId: true); - case "WixMedia": - return null; - case "WixMerge": - return DefaultTupleFromRow(typeof(WixMergeTuple), row, columnZeroIsId: true); - case "WixPatchBaseline": - return DefaultTupleFromRow(typeof(WixPatchBaselineTuple), row, columnZeroIsId: true); - case "WixProperty": - { - var attributes = FieldAsInt(row, 1); - return new WixPropertyTuple(SourceLineNumber4(row.SourceLineNumbers)) - { - PropertyRef = FieldAsString(row, 0), - Admin = (attributes & 0x1) == 0x1, - Hidden = (attributes & 0x2) == 0x2, - Secure = (attributes & 0x4) == 0x4, - }; - } - case "WixSuppressModularization": - return DefaultTupleFromRow(typeof(WixSuppressModularizationTuple), row, columnZeroIsId: true); - case "WixUI": - return DefaultTupleFromRow(typeof(WixUITuple), row, columnZeroIsId: true); - case "WixVariable": - return DefaultTupleFromRow(typeof(WixVariableTuple), row, columnZeroIsId: true); - default: - return GenericTupleFromCustomRow(row, columnZeroIsId: false); - } - } - - private static CustomActionTargetType DetermineCustomActionTargetType(int type) - { - var targetType = default(CustomActionTargetType); - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) - { - targetType = CustomActionTargetType.VBScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) - { - targetType = CustomActionTargetType.JScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) - { - targetType = CustomActionTargetType.TextData; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) - { - targetType = CustomActionTargetType.Exe; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) - { - targetType = CustomActionTargetType.Dll; - } - - return targetType; - } - - private static CustomActionSourceType DetermineCustomActionSourceType(int type) - { - var sourceType = CustomActionSourceType.Binary; - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) - { - sourceType = CustomActionSourceType.Property; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) - { - sourceType = CustomActionSourceType.Directory; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) - { - sourceType = CustomActionSourceType.File; - } - - return sourceType; - } - - private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) - { - var executionType = CustomActionExecutionType.Immediate; - - if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) - { - executionType = CustomActionExecutionType.Commit; - } - else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) - { - executionType = CustomActionExecutionType.Rollback; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) - { - executionType = CustomActionExecutionType.Deferred; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) - { - executionType = CustomActionExecutionType.ClientRepeat; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) - { - executionType = CustomActionExecutionType.OncePerProcess; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) - { - executionType = CustomActionExecutionType.FirstSequence; - } - - return executionType; - } - - private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) - { - switch (columnType) - { - case Wix3.ColumnType.Number: - return IntermediateFieldType.Number; - case Wix3.ColumnType.Object: - return IntermediateFieldType.Path; - case Wix3.ColumnType.Unknown: - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Preserved: - default: - return IntermediateFieldType.String; - } - } - - private static IntermediateTuple DefaultTupleFromRow(Type tupleType, Wix3.Row row, bool columnZeroIsId) - { - var tuple = Activator.CreateInstance(tupleType) as IntermediateTuple; - - SetTupleFieldsFromRow(row, tuple, columnZeroIsId); - - tuple.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); - return tuple; - } - - private static IntermediateTuple GenericTupleFromCustomRow(Wix3.Row row, bool columnZeroIsId) - { - var columnDefinitions = row.Table.Definition.Columns.Cast(); - var fieldDefinitions = columnDefinitions.Select(columnDefinition => - new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); - var tupleDefinition = new IntermediateTupleDefinition(row.Table.Name, fieldDefinitions, null); - var tuple = new IntermediateTuple(tupleDefinition, SourceLineNumber4(row.SourceLineNumbers)); - - SetTupleFieldsFromRow(row, tuple, columnZeroIsId); - - return tuple; - } - - private static void SetTupleFieldsFromRow(Wix3.Row row, IntermediateTuple tuple, bool columnZeroIsId) - { - int offset = 0; - if (columnZeroIsId) - { - tuple.Id = GetIdentifierForRow(row); - offset = 1; - } - - for (var i = offset; i < row.Fields.Length; ++i) - { - var column = row.Fields[i].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - tuple.Set(i - offset, FieldAsString(row, i)); - break; - case Wix3.ColumnType.Number: - int? nullableValue = FieldAsNullableInt(row, i); - // TODO: Consider whether null values should be coerced to their default value when - // a column is not nullable. For now, just pass through the null. - //int value = FieldAsInt(row, i); - //tuple.Set(i - offset, column.IsNullable ? nullableValue : value); - tuple.Set(i - offset, nullableValue); - break; - case Wix3.ColumnType.Unknown: - break; - } - } - } - - private static Identifier GetIdentifierForRow(Wix3.Row row) - { - var column = row.Fields[0].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); - case Wix3.ColumnType.Number: - return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); - default: - return null; - } - } - - private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) - { - switch (outputType) - { - case Wix3.OutputType.Bundle: - return SectionType.Bundle; - case Wix3.OutputType.Module: - return SectionType.Module; - case Wix3.OutputType.Patch: - return SectionType.Patch; - case Wix3.OutputType.PatchCreation: - return SectionType.PatchCreation; - case Wix3.OutputType.Product: - return SectionType.Product; - case Wix3.OutputType.Transform: - case Wix3.OutputType.Unknown: - default: - return SectionType.Unknown; - } - } - - private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) - { - return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); - } - - private static string FieldAsString(Wix3.Row row, int column) - { - return (string)row[column]; - } - - private static int FieldAsInt(Wix3.Row row, int column) - { - return Convert.ToInt32(row[column]); - } - - private static int? FieldAsNullableInt(Wix3.Row row, int column) - { - var field = row.Fields[column]; - if (field.Data == null) - { - return null; - } - else - { - return Convert.ToInt32(field.Data); - } - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : null, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : null - }; - } - } -} diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs index a180e20d..5df577f6 100644 --- a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs +++ b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs @@ -27,10 +27,8 @@ namespace WixToolsetTest.Converters.Tupleizer var intermediateFolder = fs.GetFolder(); var path = Path.Combine(dataFolder, "test.wixout"); - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - var command = new ConvertTuplesCommand(); - var intermediate = command.Execute(output); + var intermediate = ConvertTuples.ConvertFile(path); Assert.NotNull(intermediate); Assert.Single(intermediate.Sections); @@ -43,6 +41,7 @@ namespace WixToolsetTest.Converters.Tupleizer intermediate = Intermediate.Load(wixiplFile); + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. -- cgit v1.2.3-55-g6feb From 4a66f8c3acaa19016f45d9a1b3c35719f44b007b Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Wed, 26 Jun 2019 15:27:06 -0400 Subject: Create target-specific Tupleizer NuGet package. --- .../WixToolset.Converters.Tupleizer.csproj | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj index a162807a..d9d92f4f 100644 --- a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj +++ b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj @@ -4,7 +4,7 @@ - netstandard2.0 + netstandard2.0;net461 Tupleizer WiX Toolset Converters Tuplizer embedded @@ -18,6 +18,7 @@ + -- cgit v1.2.3-55-g6feb From 133bbd2b519bf977638317fba3284ba02817f7bb Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sun, 20 Oct 2019 00:34:24 -0700 Subject: Fix converter a bit more --- src/WixToolset.Converters.Tupleizer/ConvertTuples.cs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs index 88fe0575..60e72c62 100644 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs @@ -103,7 +103,7 @@ namespace WixToolset.Converters.Tupleizer case "Class": return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); case "CompLocator": - return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: true); + return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: false); case "Component": { var attributes = FieldAsNullableInt(row, 3); @@ -278,7 +278,7 @@ namespace WixToolset.Converters.Tupleizer { tuple.DirectoryRef = FieldAsString(wixFileRow, 4); tuple.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; - tuple.Source = new IntermediateFieldPathValue() { Path = FieldAsString(wixFileRow, 6) }; + tuple.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; tuple.PatchGroup = FieldAsInt(wixFileRow, 8); tuple.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileTupleAttributes.GeneratedShortFileName : 0; tuple.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); @@ -290,6 +290,8 @@ namespace WixToolset.Converters.Tupleizer return null; case "Icon": return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: true); + case "IniLocator": + return DefaultTupleFromRow(typeof(IniLocatorTuple), row, columnZeroIsId: false); case "InstallExecuteSequence": return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); case "LockPermissions": @@ -497,7 +499,7 @@ namespace WixToolset.Converters.Tupleizer }; } case "Signature": - return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: false); + return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: true); case "UIText": return DefaultTupleFromRow(typeof(UITextTuple), row, columnZeroIsId: true); case "Upgrade": -- cgit v1.2.3-55-g6feb From 57bcf8079d2e08eb87ba4915227cabe706a63f5d Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sun, 20 Oct 2019 00:35:49 -0700 Subject: Better support all .NETs --- .../WixToolset.Converters.Tupleizer.csproj | 3 ++- src/WixToolset.Converters/WixToolset.Converters.csproj | 2 +- src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj | 4 ++++ 3 files changed, 7 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj index d9d92f4f..3fa1b57d 100644 --- a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj +++ b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj @@ -4,7 +4,7 @@ - netstandard2.0;net461 + netstandard2.0;net461;net472 Tupleizer WiX Toolset Converters Tuplizer embedded @@ -18,6 +18,7 @@ + diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj index 94a956d5..d223cf44 100644 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -4,7 +4,7 @@ - netstandard2.0 + netstandard2.0;net461;net472 Converter WiX Toolset Converters embedded diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index d16c3d16..026a7d3e 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -7,6 +7,10 @@ false + + NU1701 + + -- cgit v1.2.3-55-g6feb From 28f9377dca4072528685269472e25f76ef0d0a55 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 25 Oct 2019 00:55:04 -0700 Subject: Update to latest Data --- src/WixToolset.Converters.Tupleizer/ConvertTuples.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs index 60e72c62..a115acf1 100644 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs @@ -42,7 +42,7 @@ namespace WixToolset.Converters.Tupleizer } } - return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null, embedFilePaths: null); + return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); } private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) -- cgit v1.2.3-55-g6feb From 8b1861a0d9fc636f02ccb9452946863e31a46b78 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Thu, 31 Oct 2019 20:10:49 -0400 Subject: Add namespace to elements. --- src/WixToolset.Converters/Wix3Converter.cs | 6 +++-- .../WixToolsetTest.Converters/ConverterFixture.cs | 31 +++++++++++++++++++++- 2 files changed, 34 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index c23930b6..9fde7360 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -35,6 +35,7 @@ namespace WixToolset.Converters private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; private static readonly XName PropertyElementName = WixNamespace + "Property"; private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; + private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() { @@ -86,7 +87,8 @@ namespace WixToolset.Converters { Wix3Converter.PayloadElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.CustomActionElementName, this.ConvertCustomActionElement }, { Wix3Converter.PropertyElementName, this.ConvertPropertyElement }, - { Wix3Converter.WixElementWithoutNamespaceName, this.ConvertWixElementWithoutNamespace }, + { Wix3Converter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, + { Wix3Converter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, }; this.Messaging = messaging; @@ -399,7 +401,7 @@ namespace WixToolset.Converters /// /// The Wix element to convert. /// The converted element. - private void ConvertWixElementWithoutNamespace(XElement element) + private void ConvertElementWithoutNamespace(XElement element) { if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) { diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 97769cd6..71069333 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -364,7 +364,7 @@ namespace WixToolsetTest.Converters } [Fact] - public void CanConvertMissingNamespace() + public void CanConvertMissingWixNamespace() { var parse = String.Join(Environment.NewLine, "", @@ -392,6 +392,35 @@ namespace WixToolsetTest.Converters Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); } + [Fact] + public void CanConvertMissingIncludeNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + } + [Fact] public void CanConvertAnonymousFile() { -- cgit v1.2.3-55-g6feb From 2c6285da46439ec98f89f09e2029f801924014ed Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Fri, 1 Nov 2019 18:03:29 -0400 Subject: Handle CustomTable/@BootstrapperApplicationData. --- src/WixToolset.Converters/Wix3Converter.cs | 548 +++++++++++---------- .../WixToolsetTest.Converters/ConverterFixture.cs | 28 ++ 2 files changed, 311 insertions(+), 265 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 9fde7360..b4ce1064 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -25,6 +25,7 @@ namespace WixToolset.Converters private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; + private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; private static readonly XName FileElementName = WixNamespace + "File"; private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; @@ -78,6 +79,7 @@ namespace WixToolset.Converters { this.ConvertElementMapping = new Dictionary> { + { Wix3Converter.CustomTableElementName, this.ConvertCustomTableElement }, { Wix3Converter.DirectoryElementName, this.ConvertDirectoryElement }, { Wix3Converter.FileElementName, this.ConvertFileElement }, { Wix3Converter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, @@ -292,363 +294,379 @@ namespace WixToolset.Converters } } - private void ConvertDirectoryElement(XElement element) + private void ConvertCustomTableElement(XElement element) { - if (null == element.Attribute("Name")) + var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); + if (bootstrapperApplicationData != null + && this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) { - var attribute = element.Attribute("ShortName"); - if (null != attribute) + element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); + bootstrapperApplicationData.Remove(); + } + } + + private void ConvertDirectoryElement(XElement element) + { + if (null == element.Attribute("Name")) + { + var attribute = element.Attribute("ShortName"); + if (null != attribute) + { + var shortName = attribute.Value; + if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) { - var shortName = attribute.Value; - if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) - { - element.Add(new XAttribute("Name", shortName)); - attribute.Remove(); - } + element.Add(new XAttribute("Name", shortName)); + attribute.Remove(); } } } + } - private void ConvertFileElement(XElement element) + private void ConvertFileElement(XElement element) + { + if (null == element.Attribute("Id")) { - if (null == element.Attribute("Id")) + var attribute = element.Attribute("Name"); + + if (null == attribute) { - var attribute = element.Attribute("Name"); + attribute = element.Attribute("Source"); + } - if (null == attribute) - { - attribute = element.Attribute("Source"); - } + if (null != attribute) + { + var name = Path.GetFileName(attribute.Value); - if (null != attribute) + if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the default", name)) { - var name = Path.GetFileName(attribute.Value); - - if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the default", name)) - { - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - element.Add(new XAttribute("Id", GetIdentifierFromName(name))); - element.Add(attributes); - } + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + element.Add(new XAttribute("Id", GetIdentifierFromName(name))); + element.Add(attributes); } } } + } - private void ConvertSuppressSignatureValidation(XElement element) - { - var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); + private void ConvertSuppressSignatureValidation(XElement element) + { + var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); - if (null != suppressSignatureValidation) + if (null != suppressSignatureValidation) + { + if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation.Name)) { - if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation)) + if ("no" == suppressSignatureValidation.Value) { - if ("no" == suppressSignatureValidation.Value) - { - element.Add(new XAttribute("EnableSignatureValidation", "yes")); - } + element.Add(new XAttribute("EnableSignatureValidation", "yes")); } - - suppressSignatureValidation.Remove(); } + + suppressSignatureValidation.Remove(); } + } - private void ConvertCustomActionElement(XElement xCustomAction) - { - var xBinaryKey = xCustomAction.Attribute("BinaryKey"); + private void ConvertCustomActionElement(XElement xCustomAction) + { + var xBinaryKey = xCustomAction.Attribute("BinaryKey"); - if (xBinaryKey?.Value == "WixCA") + if (xBinaryKey?.Value == "WixCA") + { + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'UtilCA' instead.")) { - if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'UtilCA' instead.")) - { - xBinaryKey.Value = "UtilCA"; - } + xBinaryKey.Value = "UtilCA"; } + } - var xDllEntry = xCustomAction.Attribute("DllEntry"); + var xDllEntry = xCustomAction.Attribute("DllEntry"); - if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") + if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) - { - xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); - } + xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); } + } - var xProperty = xCustomAction.Attribute("Property"); + var xProperty = xCustomAction.Attribute("Property"); - if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") + if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) - { - xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); - } + xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); } } + } + + private void ConvertPropertyElement(XElement xProperty) + { + var xId = xProperty.Attribute("Id"); + + if (xId.Value == "QtExecCmdTimeout") + { + this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); + } + } - private void ConvertPropertyElement(XElement xProperty) + /// + /// Converts a Wix element. + /// + /// The Wix element to convert. + /// The converted element. + private void ConvertElementWithoutNamespace(XElement element) + { + if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) { - var xId = xProperty.Attribute("Id"); + element.Name = WixNamespace.GetName(element.Name.LocalName); - if (xId.Value == "QtExecCmdTimeout") + element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. + + foreach (var elementWithoutNamespace in element.Elements().Where(e => XNamespace.None == e.Name.Namespace)) { - this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); + elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); } } + } - /// - /// Converts a Wix element. - /// - /// The Wix element to convert. - /// The converted element. - private void ConvertElementWithoutNamespace(XElement element) + private IEnumerable YieldConverterTypes(IEnumerable types) + { + if (null != types) { - if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) + foreach (var type in types) { - element.Name = WixNamespace.GetName(element.Name.LocalName); - element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. - - foreach (var elementWithoutNamespace in element.Elements().Where(e => XNamespace.None == e.Name.Namespace)) + if (Enum.TryParse(type, true, out var itt)) + { + yield return itt; + } + else // not a known ConverterTestType { - elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); + this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); } } } + } - private IEnumerable YieldConverterTypes(IEnumerable types) + private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) + { + foreach (var element in elements) { - if (null != types) + + if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) { - foreach (var type in types) - { + element.Name = ns.GetName(element.Name.LocalName); + } - if (Enum.TryParse(type, true, out var itt)) - { - yield return itt; - } - else // not a known ConverterTestType + // Remove all the attributes and add them back to with their namespace updated (as necessary). + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + + foreach (var attribute in attributes) + { + var convertedAttribute = attribute; + + if (attribute.IsNamespaceDeclaration) + { + if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) { - this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); + convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); } } + else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) + { + convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); + } + + element.Add(convertedAttribute); } } + } + + /// + /// Determine if the whitespace preceding a node is appropriate for its depth level. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level that should match this whitespace. + /// The whitespace to validate. + /// true if the whitespace is legal; false otherwise. + private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) + { + // Strip off leading newlines; there can be an arbitrary number of these. + whitespace = whitespace.TrimStart(XDocumentNewLine); - private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) + var indentation = new string(' ', level * indentationAmount); + + return whitespace == indentation; + } + + /// + /// Fix the whitespace in a whitespace node. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level of the desired whitespace. + /// The whitespace node to fix. + private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) + { + var value = new StringBuilder(whitespace.Value.Length); + + // Keep any previous preceeding new lines. + var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); + + // Ensure there is always at least one new line before the indentation. + value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); + + whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); + } + + /// + /// Output an error message to the console. + /// + /// The type of converter test. + /// The node that caused the error. + /// Detailed error message. + /// Additional formatted string arguments. + /// Returns true indicating that action should be taken on this error, and false if it should be ignored. + private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) + { + if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error { - foreach (var element in elements) - { + return false; + } - if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) - { - element.Name = ns.GetName(element.Name.LocalName); - } + // Increase the error count. + this.Errors++; - // Remove all the attributes and add them back to with their namespace updated (as necessary). - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); + var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); + var warning = this.ErrorsAsWarnings.Contains(converterTestType); + var display = String.Format(CultureInfo.CurrentCulture, message, args); - foreach (var attribute in attributes) - { - var convertedAttribute = attribute; + var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); - if (attribute.IsNamespaceDeclaration) - { - if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) - { - convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); - } - } - else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) - { - convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); - } + this.Messaging.Write(msg); - element.Add(convertedAttribute); - } - } + return true; + } + + /// + /// Return an identifier based on passed file/directory name + /// + /// File/directory name to generate identifer from + /// A version of the name that is a legal identifier. + /// This is duplicated from WiX's Common class. + private static string GetIdentifierFromName(string name) + { + string result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + + // MSI identifiers must begin with an alphabetic character or an + // underscore. Prefix all other values with an underscore. + if (AddPrefix.IsMatch(name)) + { + result = String.Concat("_", result); } + return result; + } + + /// + /// Converter test types. These are used to condition error messages down to warnings. + /// + private enum ConverterTestType + { /// - /// Determine if the whitespace preceding a node is appropriate for its depth level. + /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. /// - /// Indentation value to use when validating leading whitespace. - /// The depth level that should match this whitespace. - /// The whitespace to validate. - /// true if the whitespace is legal; false otherwise. - private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) - { - // Strip off leading newlines; there can be an arbitrary number of these. - whitespace = whitespace.TrimStart(XDocumentNewLine); + ConverterTestTypeUnknown, - var indentation = new string(' ', level * indentationAmount); + /// + /// Displayed when an XML loading exception has occurred. + /// + XmlException, - return whitespace == indentation; - } + /// + /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. + /// + UnauthorizedAccessException, /// - /// Fix the whitespace in a whitespace node. + /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. /// - /// Indentation value to use when validating leading whitespace. - /// The depth level of the desired whitespace. - /// The whitespace node to fix. - private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) - { - var value = new StringBuilder(whitespace.Value.Length); + DeclarationEncodingWrong, - // Keep any previous preceeding new lines. - var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); + /// + /// Displayed when the XML declaration is missing from the source file. + /// + DeclarationMissing, - // Ensure there is always at least one new line before the indentation. - value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); + /// + /// Displayed when the whitespace preceding a CDATA node is wrong. + /// + WhitespacePrecedingCDATAWrong, - whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); - } + /// + /// Displayed when the whitespace preceding a node is wrong. + /// + WhitespacePrecedingNodeWrong, /// - /// Output an error message to the console. + /// Displayed when an element is not empty as it should be. /// - /// The type of converter test. - /// The node that caused the error. - /// Detailed error message. - /// Additional formatted string arguments. - /// Returns true indicating that action should be taken on this error, and false if it should be ignored. - private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) - { - if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error - { - return false; - } + NotEmptyElement, + + /// + /// Displayed when the whitespace following a CDATA node is wrong. + /// + WhitespaceFollowingCDATAWrong, - // Increase the error count. - this.Errors++; + /// + /// Displayed when the whitespace preceding an end element is wrong. + /// + WhitespacePrecedingEndElementWrong, + + /// + /// Displayed when the xmlns attribute is missing from the document element. + /// + XmlnsMissing, - var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); - var warning = this.ErrorsAsWarnings.Contains(converterTestType); - var display = String.Format(CultureInfo.CurrentCulture, message, args); + /// + /// Displayed when the xmlns attribute on the document element is wrong. + /// + XmlnsValueWrong, - var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); + /// + /// Assign an identifier to a File element when on Id attribute is specified. + /// + AssignAnonymousFileId, - this.Messaging.Write(msg); + /// + /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. + /// + SuppressSignatureValidationDeprecated, - return true; - } + /// + /// WixCA Binary/@Id has been renamed to UtilCA. + /// + WixCABinaryIdRenamed, /// - /// Return an identifier based on passed file/directory name + /// QtExec custom actions have been renamed. /// - /// File/directory name to generate identifer from - /// A version of the name that is a legal identifier. - /// This is duplicated from WiX's Common class. - private static string GetIdentifierFromName(string name) - { - string result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + QuietExecCustomActionsRenamed, - // MSI identifiers must begin with an alphabetic character or an - // underscore. Prefix all other values with an underscore. - if (AddPrefix.IsMatch(name)) - { - result = String.Concat("_", result); - } + /// + /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. + /// + QtExecCmdTimeoutAmbiguous, - return result; - } + /// + /// Directory/@ShortName may only be specified with Directory/@Name. + /// + AssignDirectoryNameFromShortName, /// - /// Converter test types. These are used to condition error messages down to warnings. + /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. /// - private enum ConverterTestType - { - /// - /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. - /// - ConverterTestTypeUnknown, - - /// - /// Displayed when an XML loading exception has occurred. - /// - XmlException, - - /// - /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. - /// - UnauthorizedAccessException, - - /// - /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. - /// - DeclarationEncodingWrong, - - /// - /// Displayed when the XML declaration is missing from the source file. - /// - DeclarationMissing, - - /// - /// Displayed when the whitespace preceding a CDATA node is wrong. - /// - WhitespacePrecedingCDATAWrong, - - /// - /// Displayed when the whitespace preceding a node is wrong. - /// - WhitespacePrecedingNodeWrong, - - /// - /// Displayed when an element is not empty as it should be. - /// - NotEmptyElement, - - /// - /// Displayed when the whitespace following a CDATA node is wrong. - /// - WhitespaceFollowingCDATAWrong, - - /// - /// Displayed when the whitespace preceding an end element is wrong. - /// - WhitespacePrecedingEndElementWrong, - - /// - /// Displayed when the xmlns attribute is missing from the document element. - /// - XmlnsMissing, - - /// - /// Displayed when the xmlns attribute on the document element is wrong. - /// - XmlnsValueWrong, - - /// - /// Assign an identifier to a File element when on Id attribute is specified. - /// - AssignAnonymousFileId, - - /// - /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. - /// - SuppressSignatureValidationDeprecated, - - /// - /// WixCA Binary/@Id has been renamed to UtilCA. - /// - WixCABinaryIdRenamed, - - /// - /// QtExec custom actions have been renamed. - /// - QuietExecCustomActionsRenamed, - - /// - /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. - /// - QtExecCmdTimeoutAmbiguous, - - /// - /// Directory/@ShortName may only be specified with Directory/@Name. - /// - AssignDirectoryNameFromShortName, - } + BootstrapperApplicationDataDeprecated, } } +} diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 71069333..e2c0be5b 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -449,6 +449,34 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } + [Fact] + public void CanConvertCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + [Fact] public void CanConvertShortNameDirectoryWithoutName() { -- cgit v1.2.3-55-g6feb From efcc52fdd0d767d45497ebf54765ad6da7878c6f Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Mon, 4 Nov 2019 15:02:01 -0500 Subject: When fixing namespaceless elements, fix the whole tree. --- src/WixToolset.Converters/Wix3Converter.cs | 2 +- src/test/WixToolsetTest.Converters/ConverterFixture.cs | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index b4ce1064..faff12ee 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -422,7 +422,7 @@ namespace WixToolset.Converters element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. - foreach (var elementWithoutNamespace in element.Elements().Where(e => XNamespace.None == e.Name.Namespace)) + foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) { elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); } diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index e2c0be5b..fd35ae50 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -399,12 +399,18 @@ namespace WixToolsetTest.Converters "", "", " ", + " ", + " ", + " ", ""); var expected = String.Join(Environment.NewLine, "", "", " ", + " ", + " ", + " ", ""); var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); -- cgit v1.2.3-55-g6feb From 9ba9908cc585296f2b0ed2487351853e1a490005 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Wed, 11 Dec 2019 18:58:56 -0500 Subject: Don't mess with CDATA whitespace. --- src/WixToolset.Converters/Wix3Converter.cs | 2 +- .../WixToolsetTest.Converters/ConverterFixture.cs | 27 ++++++++++++++++++++-- 2 files changed, 26 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index faff12ee..b6366a83 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -255,7 +255,7 @@ namespace WixToolset.Converters private void EnsurePrecedingWhitespaceRemoved(XText whitespace, XNode node, ConverterTestType testType) { - if (!String.IsNullOrEmpty(whitespace.Value)) + if (!String.IsNullOrEmpty(whitespace.Value) && whitespace.NodeType != XmlNodeType.CDATA) { var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index fd35ae50..cb70b35a 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -242,6 +242,25 @@ namespace WixToolsetTest.Converters Assert.Equal(2, errors); } + [Fact] + public void CanKeepCdataWithOnlyWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + var errors = converter.ConvertDocument(document); + Assert.Equal(0, errors); + } + [Fact] public void CanConvertMainNamespace() { @@ -400,7 +419,9 @@ namespace WixToolsetTest.Converters "", " ", " ", - " ", + " ", + " ", + " ", " ", ""); @@ -409,7 +430,9 @@ namespace WixToolsetTest.Converters "", " ", " ", - " ", + " ", + " ", + " ", " ", ""); -- cgit v1.2.3-55-g6feb From 4965ca76323d2ee709bc1790ed1e49ab958445b4 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Thu, 5 Mar 2020 19:52:35 -0500 Subject: Handle versioned extension ids. --- src/WixToolset.Converters/Wix3Converter.cs | 546 +++++++++++---------- .../WixToolsetTest.Converters/ConverterFixture.cs | 34 ++ 2 files changed, 311 insertions(+), 269 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index b6366a83..1ae65e4f 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -305,368 +305,376 @@ namespace WixToolset.Converters } } - private void ConvertDirectoryElement(XElement element) - { - if (null == element.Attribute("Name")) + private void ConvertDirectoryElement(XElement element) { - var attribute = element.Attribute("ShortName"); - if (null != attribute) + if (null == element.Attribute("Name")) { - var shortName = attribute.Value; - if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) + var attribute = element.Attribute("ShortName"); + if (null != attribute) { - element.Add(new XAttribute("Name", shortName)); - attribute.Remove(); + var shortName = attribute.Value; + if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) + { + element.Add(new XAttribute("Name", shortName)); + attribute.Remove(); + } } } } - } - private void ConvertFileElement(XElement element) - { - if (null == element.Attribute("Id")) + private void ConvertFileElement(XElement element) { - var attribute = element.Attribute("Name"); - - if (null == attribute) + if (null == element.Attribute("Id")) { - attribute = element.Attribute("Source"); - } + var attribute = element.Attribute("Name"); - if (null != attribute) - { - var name = Path.GetFileName(attribute.Value); + if (null == attribute) + { + attribute = element.Attribute("Source"); + } - if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the default", name)) + if (null != attribute) { - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - element.Add(new XAttribute("Id", GetIdentifierFromName(name))); - element.Add(attributes); + var name = Path.GetFileName(attribute.Value); + + if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the default", name)) + { + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + element.Add(new XAttribute("Id", GetIdentifierFromName(name))); + element.Add(attributes); + } } } } - } - - private void ConvertSuppressSignatureValidation(XElement element) - { - var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); - if (null != suppressSignatureValidation) + private void ConvertSuppressSignatureValidation(XElement element) { - if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation.Name)) + var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); + + if (null != suppressSignatureValidation) { - if ("no" == suppressSignatureValidation.Value) + if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation.Name)) { - element.Add(new XAttribute("EnableSignatureValidation", "yes")); + if ("no" == suppressSignatureValidation.Value) + { + element.Add(new XAttribute("EnableSignatureValidation", "yes")); + } } - } - suppressSignatureValidation.Remove(); + suppressSignatureValidation.Remove(); + } } - } - - private void ConvertCustomActionElement(XElement xCustomAction) - { - var xBinaryKey = xCustomAction.Attribute("BinaryKey"); - if (xBinaryKey?.Value == "WixCA") + private void ConvertCustomActionElement(XElement xCustomAction) { - if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'UtilCA' instead.")) + var xBinaryKey = xCustomAction.Attribute("BinaryKey"); + + if (xBinaryKey?.Value == "WixCA" || xBinaryKey?.Value == "UtilCA") { - xBinaryKey.Value = "UtilCA"; + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X86' instead.")) + { + xBinaryKey.Value = "Wix4UtilCA_X86"; + } } - } - - var xDllEntry = xCustomAction.Attribute("DllEntry"); - if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") - { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) + if (xBinaryKey?.Value == "WixCA_x64" || xBinaryKey?.Value == "UtilCA_x64") { - xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA_x64 custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X64' instead.")) + { + xBinaryKey.Value = "Wix4UtilCA_X64"; + } } - } - var xProperty = xCustomAction.Attribute("Property"); + var xDllEntry = xCustomAction.Attribute("DllEntry"); - if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") - { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) + if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") { - xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) + { + xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); + } } - } - } - private void ConvertPropertyElement(XElement xProperty) - { - var xId = xProperty.Attribute("Id"); + var xProperty = xCustomAction.Attribute("Property"); - if (xId.Value == "QtExecCmdTimeout") - { - this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); + if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) + { + xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); + } + } } - } - /// - /// Converts a Wix element. - /// - /// The Wix element to convert. - /// The converted element. - private void ConvertElementWithoutNamespace(XElement element) - { - if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) + private void ConvertPropertyElement(XElement xProperty) { - element.Name = WixNamespace.GetName(element.Name.LocalName); - - element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. + var xId = xProperty.Attribute("Id"); - foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) + if (xId.Value == "QtExecCmdTimeout") { - elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); + this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); } } - } - private IEnumerable YieldConverterTypes(IEnumerable types) - { - if (null != types) + /// + /// Converts a Wix element. + /// + /// The Wix element to convert. + /// The converted element. + private void ConvertElementWithoutNamespace(XElement element) { - foreach (var type in types) + if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) { + element.Name = WixNamespace.GetName(element.Name.LocalName); - if (Enum.TryParse(type, true, out var itt)) - { - yield return itt; - } - else // not a known ConverterTestType + element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. + + foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) { - this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); + elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); } } } - } - private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) - { - foreach (var element in elements) + private IEnumerable YieldConverterTypes(IEnumerable types) { - - if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) - { - element.Name = ns.GetName(element.Name.LocalName); - } - - // Remove all the attributes and add them back to with their namespace updated (as necessary). - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - - foreach (var attribute in attributes) + if (null != types) { - var convertedAttribute = attribute; - - if (attribute.IsNamespaceDeclaration) + foreach (var type in types) { - if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) + + if (Enum.TryParse(type, true, out var itt)) { - convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); + yield return itt; + } + else // not a known ConverterTestType + { + this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); } } - else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) - { - convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); - } - - element.Add(convertedAttribute); } } - } - /// - /// Determine if the whitespace preceding a node is appropriate for its depth level. - /// - /// Indentation value to use when validating leading whitespace. - /// The depth level that should match this whitespace. - /// The whitespace to validate. - /// true if the whitespace is legal; false otherwise. - private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) - { - // Strip off leading newlines; there can be an arbitrary number of these. - whitespace = whitespace.TrimStart(XDocumentNewLine); - - var indentation = new string(' ', level * indentationAmount); - - return whitespace == indentation; - } - - /// - /// Fix the whitespace in a whitespace node. - /// - /// Indentation value to use when validating leading whitespace. - /// The depth level of the desired whitespace. - /// The whitespace node to fix. - private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) - { - var value = new StringBuilder(whitespace.Value.Length); - - // Keep any previous preceeding new lines. - var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); - - // Ensure there is always at least one new line before the indentation. - value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); - - whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); - } - - /// - /// Output an error message to the console. - /// - /// The type of converter test. - /// The node that caused the error. - /// Detailed error message. - /// Additional formatted string arguments. - /// Returns true indicating that action should be taken on this error, and false if it should be ignored. - private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) - { - if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error + private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) { - return false; - } - - // Increase the error count. - this.Errors++; - - var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); - var warning = this.ErrorsAsWarnings.Contains(converterTestType); - var display = String.Format(CultureInfo.CurrentCulture, message, args); + foreach (var element in elements) + { - var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); + if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) + { + element.Name = ns.GetName(element.Name.LocalName); + } - this.Messaging.Write(msg); + // Remove all the attributes and add them back to with their namespace updated (as necessary). + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); - return true; - } + foreach (var attribute in attributes) + { + var convertedAttribute = attribute; - /// - /// Return an identifier based on passed file/directory name - /// - /// File/directory name to generate identifer from - /// A version of the name that is a legal identifier. - /// This is duplicated from WiX's Common class. - private static string GetIdentifierFromName(string name) - { - string result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + if (attribute.IsNamespaceDeclaration) + { + if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) + { + convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); + } + } + else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) + { + convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); + } - // MSI identifiers must begin with an alphabetic character or an - // underscore. Prefix all other values with an underscore. - if (AddPrefix.IsMatch(name)) - { - result = String.Concat("_", result); + element.Add(convertedAttribute); + } + } } - return result; - } - - /// - /// Converter test types. These are used to condition error messages down to warnings. - /// - private enum ConverterTestType - { - /// - /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. - /// - ConverterTestTypeUnknown, - /// - /// Displayed when an XML loading exception has occurred. + /// Determine if the whitespace preceding a node is appropriate for its depth level. /// - XmlException, - - /// - /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. - /// - UnauthorizedAccessException, + /// Indentation value to use when validating leading whitespace. + /// The depth level that should match this whitespace. + /// The whitespace to validate. + /// true if the whitespace is legal; false otherwise. + private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) + { + // Strip off leading newlines; there can be an arbitrary number of these. + whitespace = whitespace.TrimStart(XDocumentNewLine); - /// - /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. - /// - DeclarationEncodingWrong, + var indentation = new string(' ', level * indentationAmount); - /// - /// Displayed when the XML declaration is missing from the source file. - /// - DeclarationMissing, + return whitespace == indentation; + } /// - /// Displayed when the whitespace preceding a CDATA node is wrong. + /// Fix the whitespace in a whitespace node. /// - WhitespacePrecedingCDATAWrong, + /// Indentation value to use when validating leading whitespace. + /// The depth level of the desired whitespace. + /// The whitespace node to fix. + private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) + { + var value = new StringBuilder(whitespace.Value.Length); - /// - /// Displayed when the whitespace preceding a node is wrong. - /// - WhitespacePrecedingNodeWrong, + // Keep any previous preceeding new lines. + var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); - /// - /// Displayed when an element is not empty as it should be. - /// - NotEmptyElement, + // Ensure there is always at least one new line before the indentation. + value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); - /// - /// Displayed when the whitespace following a CDATA node is wrong. - /// - WhitespaceFollowingCDATAWrong, + whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); + } /// - /// Displayed when the whitespace preceding an end element is wrong. + /// Output an error message to the console. /// - WhitespacePrecedingEndElementWrong, + /// The type of converter test. + /// The node that caused the error. + /// Detailed error message. + /// Additional formatted string arguments. + /// Returns true indicating that action should be taken on this error, and false if it should be ignored. + private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) + { + if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error + { + return false; + } - /// - /// Displayed when the xmlns attribute is missing from the document element. - /// - XmlnsMissing, + // Increase the error count. + this.Errors++; - /// - /// Displayed when the xmlns attribute on the document element is wrong. - /// - XmlnsValueWrong, + var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); + var warning = this.ErrorsAsWarnings.Contains(converterTestType); + var display = String.Format(CultureInfo.CurrentCulture, message, args); - /// - /// Assign an identifier to a File element when on Id attribute is specified. - /// - AssignAnonymousFileId, + var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); - /// - /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. - /// - SuppressSignatureValidationDeprecated, + this.Messaging.Write(msg); - /// - /// WixCA Binary/@Id has been renamed to UtilCA. - /// - WixCABinaryIdRenamed, + return true; + } /// - /// QtExec custom actions have been renamed. + /// Return an identifier based on passed file/directory name /// - QuietExecCustomActionsRenamed, + /// File/directory name to generate identifer from + /// A version of the name that is a legal identifier. + /// This is duplicated from WiX's Common class. + private static string GetIdentifierFromName(string name) + { + string result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". - /// - /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. - /// - QtExecCmdTimeoutAmbiguous, + // MSI identifiers must begin with an alphabetic character or an + // underscore. Prefix all other values with an underscore. + if (AddPrefix.IsMatch(name)) + { + result = String.Concat("_", result); + } - /// - /// Directory/@ShortName may only be specified with Directory/@Name. - /// - AssignDirectoryNameFromShortName, + return result; + } /// - /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. + /// Converter test types. These are used to condition error messages down to warnings. /// - BootstrapperApplicationDataDeprecated, + private enum ConverterTestType + { + /// + /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. + /// + ConverterTestTypeUnknown, + + /// + /// Displayed when an XML loading exception has occurred. + /// + XmlException, + + /// + /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. + /// + UnauthorizedAccessException, + + /// + /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. + /// + DeclarationEncodingWrong, + + /// + /// Displayed when the XML declaration is missing from the source file. + /// + DeclarationMissing, + + /// + /// Displayed when the whitespace preceding a CDATA node is wrong. + /// + WhitespacePrecedingCDATAWrong, + + /// + /// Displayed when the whitespace preceding a node is wrong. + /// + WhitespacePrecedingNodeWrong, + + /// + /// Displayed when an element is not empty as it should be. + /// + NotEmptyElement, + + /// + /// Displayed when the whitespace following a CDATA node is wrong. + /// + WhitespaceFollowingCDATAWrong, + + /// + /// Displayed when the whitespace preceding an end element is wrong. + /// + WhitespacePrecedingEndElementWrong, + + /// + /// Displayed when the xmlns attribute is missing from the document element. + /// + XmlnsMissing, + + /// + /// Displayed when the xmlns attribute on the document element is wrong. + /// + XmlnsValueWrong, + + /// + /// Assign an identifier to a File element when on Id attribute is specified. + /// + AssignAnonymousFileId, + + /// + /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. + /// + SuppressSignatureValidationDeprecated, + + /// + /// WixCA Binary/@Id has been renamed to UtilCA. + /// + WixCABinaryIdRenamed, + + /// + /// QtExec custom actions have been renamed. + /// + QuietExecCustomActionsRenamed, + + /// + /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. + /// + QtExecCmdTimeoutAmbiguous, + + /// + /// Directory/@ShortName may only be specified with Directory/@Name. + /// + AssignDirectoryNameFromShortName, + + /// + /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. + /// + BootstrapperApplicationDataDeprecated, + } } } -} diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index cb70b35a..c6037787 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -590,6 +590,40 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } + [Fact] + public void CanConvertCustomAction() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new DummyMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(6, errors); + Assert.Equal(expected, actual); + } + private static string UnformattedDocumentString(XDocument document) { var sb = new StringBuilder(); -- cgit v1.2.3-55-g6feb From bc389bb124f622456719c2ddb15cd1b2355297a7 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Fri, 8 May 2020 20:23:29 -0400 Subject: Remove unused tuple references. --- src/WixToolset.Converters.Tupleizer/ConvertTuples.cs | 4 ---- 1 file changed, 4 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs index a115acf1..a53c3a74 100644 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs +++ b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs @@ -86,8 +86,6 @@ namespace WixToolset.Converters.Tupleizer return DefaultTupleFromRow(typeof(SummaryInformationTuple), row, columnZeroIsId: false); case "ActionText": return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); - case "AdvtExecuteSequence": - return DefaultTupleFromRow(typeof(AdvtExecuteSequenceTuple), row, columnZeroIsId: false); case "AppId": return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); case "AppSearch": @@ -292,8 +290,6 @@ namespace WixToolset.Converters.Tupleizer return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: true); case "IniLocator": return DefaultTupleFromRow(typeof(IniLocatorTuple), row, columnZeroIsId: false); - case "InstallExecuteSequence": - return DefaultTupleFromRow(typeof(InstallExecuteSequenceTuple), row, columnZeroIsId: false); case "LockPermissions": return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); case "Media": -- cgit v1.2.3-55-g6feb From 1e9243a38caaf9eecff0dff995d50fdb4897aa1b Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sat, 23 May 2020 21:04:34 +1000 Subject: Remove unused test data. --- .../Preprocessor/ConvertedPreprocessor.wxs | 62 --------------------- .../TestData/Preprocessor/Preprocessor.wxs | 63 --------------------- .../TestData/Preprocessor/wixcop.settings.xml | 9 --- .../TestData/QtExec.bad/v3.wxs | 65 ---------------------- .../TestData/QtExec.bad/v4_expected.wxs | 64 --------------------- .../TestData/QtExec/v3.wxs | 64 --------------------- .../TestData/QtExec/v4_expected.wxs | 63 --------------------- .../TestData/SingleFile/ConvertedSingleFile.wxs | 60 -------------------- .../TestData/SingleFile/SingleFile.wxs | 61 -------------------- .../WixToolsetTest.Converters.csproj | 16 ------ 10 files changed, 527 deletions(-) delete mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs (limited to 'src') diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs deleted file mode 100644 index dcd43e35..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs deleted file mode 100644 index 2eb908c2..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml deleted file mode 100644 index 9d3ad496..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs deleted file mode 100644 index b0630f65..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs deleted file mode 100644 index be487147..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs deleted file mode 100644 index 8d81a758..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs deleted file mode 100644 index 22a961b2..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs deleted file mode 100644 index aacb68fa..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs deleted file mode 100644 index 310ae811..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 026a7d3e..14546fd6 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -11,22 +11,6 @@ NU1701 - - - - - - - - - - - - - - - - -- cgit v1.2.3-55-g6feb From a783c83bc1e1efaf054d957c8a097386cb8f6b4a Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sat, 23 May 2020 21:59:02 +1000 Subject: Handle util:PermissionEx/@Inheritable --- src/WixToolset.Converters/Wix3Converter.cs | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 1ae65e4f..66ccd9d3 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -24,7 +24,9 @@ namespace WixToolset.Converters private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; + private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; + private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; private static readonly XName FileElementName = WixNamespace + "File"; @@ -33,6 +35,7 @@ namespace WixToolset.Converters private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; private static readonly XName PayloadElementName = WixNamespace + "Payload"; + private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; private static readonly XName PropertyElementName = WixNamespace + "Property"; private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; @@ -52,7 +55,7 @@ namespace WixToolset.Converters { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, { "http://schemas.microsoft.com/wix/TagExtension", "http://wixtoolset.org/schemas/v4/wxs/tag" }, - { "http://schemas.microsoft.com/wix/UtilExtension", "http://wixtoolset.org/schemas/v4/wxs/util" }, + { "http://schemas.microsoft.com/wix/UtilExtension", WixUtilNamespace }, { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, { "http://schemas.microsoft.com/wix/2009/Lux", "http://wixtoolset.org/schemas/v4/lux" }, @@ -88,6 +91,7 @@ namespace WixToolset.Converters { Wix3Converter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.PayloadElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.CustomActionElementName, this.ConvertCustomActionElement }, + { Wix3Converter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, { Wix3Converter.PropertyElementName, this.ConvertPropertyElement }, { Wix3Converter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, { Wix3Converter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, @@ -417,6 +421,21 @@ namespace WixToolset.Converters } } + private void ConvertUtilPermissionExElement(XElement element) + { + if (null == element.Attribute("Inheritable")) + { + var inheritable = element.Parent.Name == CreateFolderElementName; + if (!inheritable) + { + if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default")) + { + element.Add(new XAttribute("Inheritable", "no")); + } + } + } + } + /// /// Converts a Wix element. /// @@ -675,6 +694,11 @@ namespace WixToolset.Converters /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. /// BootstrapperApplicationDataDeprecated, + + /// + /// Inheritable is new and is now defaulted to 'yes' which is a change in behavior for all but children of CreateFolder. + /// + AssignPermissionExInheritable, } } } -- cgit v1.2.3-55-g6feb From 60c9a081d337bf432a61bee6784d4c05da1a049a Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 6 Jun 2020 15:40:38 -0700 Subject: Expose converter as a command-line command for use by wix.exe --- .../WixToolset.Converters.Tupleizer.csproj | 2 +- src/WixToolset.Converters/ConvertCommand.cs | 281 +++++++++++++++++++++ .../ConverterExtensionCommandLine.cs | 39 +++ .../ConverterExtensionFactory.cs | 30 +++ .../WixToolset.Converters.csproj | 2 +- .../WixToolsetCoreServiceProviderExtensions.cs | 17 ++ ...lsetTest.Converters.Tupleizer.v3.ncrunchproject | 9 + 7 files changed, 378 insertions(+), 2 deletions(-) create mode 100644 src/WixToolset.Converters/ConvertCommand.cs create mode 100644 src/WixToolset.Converters/ConverterExtensionCommandLine.cs create mode 100644 src/WixToolset.Converters/ConverterExtensionFactory.cs create mode 100644 src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs create mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject (limited to 'src') diff --git a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj index 3fa1b57d..cafb5feb 100644 --- a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj +++ b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj @@ -28,7 +28,7 @@ - + diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs new file mode 100644 index 00000000..a684bc95 --- /dev/null +++ b/src/WixToolset.Converters/ConvertCommand.cs @@ -0,0 +1,281 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Xml; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + internal class ConvertCommand : ICommandLineCommand + { + private const string SettingsFileDefault = "wixcop.settings.xml"; + + public ConvertCommand(IWixToolsetServiceProvider serviceProvider) + { + this.Messaging = serviceProvider.GetService(); + + this.IndentationAmount = 4; // default indentation amount + this.ErrorsAsWarnings = new HashSet(); + this.ExemptFiles = new HashSet(); + this.IgnoreErrors = new HashSet(); + this.SearchPatternResults = new HashSet(); + this.SearchPatterns = new List(); + } + + private IMessaging Messaging { get; } + + public bool ShowLogo { get; private set; } + + public bool StopParsing { get; private set; } + + private bool ShowHelp { get; set; } + + private HashSet ErrorsAsWarnings { get; } + + private HashSet ExemptFiles { get; } + + private bool FixErrors { get; set; } + + private int IndentationAmount { get; set; } + + private HashSet IgnoreErrors { get; } + + private HashSet SearchPatternResults { get; } + + private List SearchPatterns { get; } + + private string SettingsFile1 { get; set; } + + private string SettingsFile2 { get; set; } + + private bool SubDirectories { get; set; } + + public bool TryParseArgument(ICommandLineParser parser, string argument) + { + if (!parser.IsSwitch(argument)) + { + this.SearchPatterns.Add(argument); + return true; + } + + var parameter = argument.Substring(1); + switch (parameter.ToLowerInvariant()) + { + case "?": + this.ShowHelp = true; + this.ShowLogo = true; + this.StopParsing = true; + return true; + + case "f": + this.FixErrors = true; + return true; + + case "nologo": + this.ShowLogo = false; + return true; + + case "s": + this.SubDirectories = true; + return true; + + default: // other parameters + if (parameter.StartsWith("set1", StringComparison.Ordinal)) + { + this.SettingsFile1 = parameter.Substring(4); + return true; + } + else if (parameter.StartsWith("set2", StringComparison.Ordinal)) + { + this.SettingsFile2 = parameter.Substring(4); + return true; + } + else if (parameter.StartsWith("indent:", StringComparison.Ordinal)) + { + try + { + this.IndentationAmount = Convert.ToInt32(parameter.Substring(7)); + } + catch + { + parser.ErrorArgument = parameter; // $"Invalid numeric argument: {parameter}"; + } + return true; + } + + return false; + } + } + + public int Execute() + { + if (this.ShowHelp) + { + DisplayHelp(); + return 1; + } + + // parse the settings if any were specified + if (null != this.SettingsFile1 || null != this.SettingsFile2) + { + this.ParseSettingsFiles(this.SettingsFile1, this.SettingsFile2); + } + else + { + if (File.Exists(ConvertCommand.SettingsFileDefault)) + { + this.ParseSettingsFiles(ConvertCommand.SettingsFileDefault, null); + } + } + + var converter = new Wix3Converter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); + + var errors = this.InspectSubDirectories(converter, Path.GetFullPath(".")); + + foreach (var searchPattern in this.SearchPatterns) + { + if (!this.SearchPatternResults.Contains(searchPattern)) + { + Console.Error.WriteLine("Could not find file \"{0}\"", searchPattern); + errors++; + } + } + + return errors != 0 ? 2 : 0; + } + + private static void DisplayHelp() + { + Console.WriteLine(" usage: wix.exe convert sourceFile [sourceFile ...]"); + Console.WriteLine(); + Console.WriteLine(" -f fix errors automatically for writable files"); + Console.WriteLine(" -nologo suppress displaying the logo information"); + Console.WriteLine(" -s search for matching files in current dir and subdirs"); + Console.WriteLine(" -set1 primary settings file"); + Console.WriteLine(" -set2 secondary settings file (overrides primary)"); + Console.WriteLine(" -indent: indentation multiple (overrides default of 4)"); + Console.WriteLine(" -? this help information"); + Console.WriteLine(); + Console.WriteLine(" sourceFile may use wildcards like *.wxs"); + } + + /// + /// Get the files that match a search path pattern. + /// + /// The base directory at which to begin the search. + /// The search path pattern. + /// The files matching the pattern. + private static string[] GetFiles(string baseDir, string searchPath) + { + // convert alternate directory separators to the standard one + var filePath = searchPath.Replace(Path.AltDirectorySeparatorChar, Path.DirectorySeparatorChar); + var lastSeparator = filePath.LastIndexOf(Path.DirectorySeparatorChar); + string[] files = null; + + try + { + if (0 > lastSeparator) + { + files = Directory.GetFiles(baseDir, filePath); + } + else // found directory separator + { + var searchPattern = filePath.Substring(lastSeparator + 1); + + files = Directory.GetFiles(filePath.Substring(0, lastSeparator + 1), searchPattern); + } + } + catch (DirectoryNotFoundException) + { + // don't let this function throw the DirectoryNotFoundException. (this exception + // occurs for non-existant directories and invalid characters in the searchPattern) + } + + return files; + } + + /// + /// Inspect sub-directories. + /// + /// The directory whose sub-directories will be inspected. + /// The number of errors that were found. + private int InspectSubDirectories(Wix3Converter converter, string directory) + { + var errors = 0; + + foreach (var searchPattern in this.SearchPatterns) + { + foreach (var sourceFilePath in GetFiles(directory, searchPattern)) + { + var file = new FileInfo(sourceFilePath); + + if (!this.ExemptFiles.Contains(file.Name.ToUpperInvariant())) + { + this.SearchPatternResults.Add(searchPattern); + errors += converter.ConvertFile(file.FullName, this.FixErrors); + } + } + } + + if (this.SubDirectories) + { + foreach (var childDirectoryPath in Directory.GetDirectories(directory)) + { + errors += this.InspectSubDirectories(converter, childDirectoryPath); + } + } + + return errors; + } + + /// + /// Parse the primary and secondary settings files. + /// + /// The primary settings file. + /// The secondary settings file. + private void ParseSettingsFiles(string localSettingsFile1, string localSettingsFile2) + { + if (null == localSettingsFile1 && null != localSettingsFile2) + { + throw new ArgumentException("Cannot specify a secondary settings file (set2) without a primary settings file (set1).", nameof(localSettingsFile2)); + } + + var settingsFile = localSettingsFile1; + while (null != settingsFile) + { + var doc = new XmlDocument(); + doc.Load(settingsFile); + + // get the types of tests that will have their errors displayed as warnings + var testsIgnoredElements = doc.SelectNodes("/Settings/IgnoreErrors/Test"); + foreach (XmlElement test in testsIgnoredElements) + { + var key = test.GetAttribute("Id"); + this.IgnoreErrors.Add(key); + } + + // get the types of tests that will have their errors displayed as warnings + var testsAsWarningsElements = doc.SelectNodes("/Settings/ErrorsAsWarnings/Test"); + foreach (XmlElement test in testsAsWarningsElements) + { + var key = test.GetAttribute("Id"); + this.ErrorsAsWarnings.Add(key); + } + + // get the exempt files + var localExemptFiles = doc.SelectNodes("/Settings/ExemptFiles/File"); + foreach (XmlElement file in localExemptFiles) + { + var key = file.GetAttribute("Name").ToUpperInvariant(); + this.ExemptFiles.Add(key); + } + + settingsFile = localSettingsFile2; + localSettingsFile2 = null; + } + } + } +} diff --git a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs new file mode 100644 index 00000000..ed4b613e --- /dev/null +++ b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs @@ -0,0 +1,39 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + /// + /// Parses the "convert" command-line command. See ConvertCommand for + /// the bulk of the command-line processing. + /// + internal class ConverterExtensionCommandLine : BaseExtensionCommandLine + { + public ConverterExtensionCommandLine(IWixToolsetServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + } + + private IWixToolsetServiceProvider ServiceProvider { get; } + + // TODO: Do something with CommandLineSwitches + public override IEnumerable CommandLineSwitches => base.CommandLineSwitches; + + public override bool TryParseCommand(ICommandLineParser parser, string argument, out ICommandLineCommand command) + { + command = null; + + if ("convert".Equals(argument, StringComparison.OrdinalIgnoreCase)) + { + command = new ConvertCommand(this.ServiceProvider); + } + + return command != null; + } + } +} diff --git a/src/WixToolset.Converters/ConverterExtensionFactory.cs b/src/WixToolset.Converters/ConverterExtensionFactory.cs new file mode 100644 index 00000000..51099e67 --- /dev/null +++ b/src/WixToolset.Converters/ConverterExtensionFactory.cs @@ -0,0 +1,30 @@ +// 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.Converters +{ + using System; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + + internal class ConverterExtensionFactory : IExtensionFactory + { + public ConverterExtensionFactory(IWixToolsetServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + } + + private IWixToolsetServiceProvider ServiceProvider { get; } + + public bool TryCreateExtension(Type extensionType, out object extension) + { + extension = null; + + if (extensionType == typeof(IExtensionCommandLine)) + { + extension = new ConverterExtensionCommandLine(this.ServiceProvider); + } + + return extension != null; + } + } +} diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj index d223cf44..1e443877 100644 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -20,7 +20,7 @@ - + diff --git a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs new file mode 100644 index 00000000..afc33f62 --- /dev/null +++ b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs @@ -0,0 +1,17 @@ +// 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.Converters +{ + using WixToolset.Extensibility.Services; + + public static class WixToolsetCoreServiceProviderExtensions + { + public static IWixToolsetCoreServiceProvider AddConverter(this IWixToolsetCoreServiceProvider serviceProvider) + { + var extensionManager = serviceProvider.GetService(); + extensionManager.Add(typeof(ConverterExtensionFactory).Assembly); + + return serviceProvider; + } + } +} diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject b/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject new file mode 100644 index 00000000..bb70cf0f --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject @@ -0,0 +1,9 @@ + + + + + WixToolsetTest.Converters.Tupleizer.ConvertTuplesFixture.CanLoadWixoutAndConvertToIntermediate + + + + \ No newline at end of file -- cgit v1.2.3-55-g6feb From 8c76578ce852a04f7ebeb8631f67913daa3ab307 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sun, 7 Jun 2020 07:58:59 -0700 Subject: Migrate integration tests from Tools repo --- .../ConverterIntegrationFixture.cs | 172 +++++++++++++++++++++ .../Mocks/MockCoreServiceProvider.cs | 51 ++++++ .../Mocks/MockMessaging.cs | 40 +++++ .../TestData/PermissionEx/v3.wxs | 27 ++++ .../TestData/PermissionEx/v4_expected.wxs | 27 ++++ .../Preprocessor/ConvertedPreprocessor.wxs | 62 ++++++++ .../TestData/Preprocessor/Preprocessor.wxs | 63 ++++++++ .../TestData/Preprocessor/wixcop.settings.xml | 9 ++ .../TestData/QtExec.bad/v3.wxs | 65 ++++++++ .../TestData/QtExec.bad/v4_expected.wxs | 64 ++++++++ .../TestData/QtExec/v3.wxs | 64 ++++++++ .../TestData/QtExec/v4_expected.wxs | 63 ++++++++ .../TestData/SingleFile/ConvertedSingleFile.wxs | 60 +++++++ .../TestData/SingleFile/SingleFile.wxs | 61 ++++++++ .../WixToolsetTest.Converters.csproj | 15 ++ 15 files changed, 843 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs create mode 100644 src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs create mode 100644 src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs create mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs (limited to 'src') diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs new file mode 100644 index 00000000..6138fd2b --- /dev/null +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -0,0 +1,172 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolset.Core; + using WixToolset.Core.TestPackage; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ConverterIntegrationFixture + { + [Fact] + public void CanConvertPermissionExFile() + { + const string beforeFileName = "v3.wxs"; + const string afterFileName = "v4_expected.wxs"; + var folder = TestData.Get(@"TestData\PermissionEx"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 4); + var errors = converter.ConvertFile(targetFile, true); + + Assert.Equal(8, errors); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void CanConvertSingleFile() + { + const string beforeFileName = "SingleFile.wxs"; + const string afterFileName = "ConvertedSingleFile.wxs"; + var folder = TestData.Get(@"TestData\SingleFile"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 4); + var errors = converter.ConvertFile(targetFile, true); + + Assert.Equal(5, errors); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void RetainsPreprocessorInstructions() + { + const string beforeFileName = "Preprocessor.wxs"; + const string afterFileName = "ConvertedPreprocessor.wxs"; + var folder = TestData.Get(@"TestData\Preprocessor"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var settingsFile = Path.Combine(folder, "wixcop.settings.xml"); + + var result = RunConversion(targetFile, settingsFile: settingsFile); + Assert.Equal(2, result.ExitCode); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void CanConvertQtExec() + { + const string beforeFileName = "v3.wxs"; + const string afterFileName = "v4_expected.wxs"; + var folder = TestData.Get(@"TestData\QtExec"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var result = RunConversion(targetFile); + Assert.Equal(2, result.ExitCode); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void DetectUnconvertableQtExecCmdTimeout() + { + const string beforeFileName = "v3.wxs"; + const string afterFileName = "v4_expected.wxs"; + var folder = TestData.Get(@"TestData\QtExec.bad"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var result = RunConversion(targetFile); + + Assert.Equal(2, result.ExitCode); + Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + // still fails because QtExecCmdTimeoutAmbiguous is unfixable + var result2 = RunConversion(targetFile); + Assert.Equal(2, result2.ExitCode); + } + } + + private static WixRunnerResult RunConversion(string targetFile, bool fixErrors = true, string settingsFile = null) + { + var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider().AddConverter(); + + var exitCode = WixRunner.Execute(new[] + { + "convert", + fixErrors ? "-f" : null, + String.IsNullOrEmpty(settingsFile) ? null : "-set1" + settingsFile, + targetFile + }, serviceProvider, out var messages); + + return new WixRunnerResult { ExitCode = exitCode, Messages = messages.ToArray() }; + } + + private static void EnsureFixed(string targetFile) + { + var messaging2 = new MockMessaging(); + var converter2 = new Wix3Converter(messaging2, 4); + var errors2 = converter2.ConvertFile(targetFile, true); + Assert.Equal(0, errors2); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs b/src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs new file mode 100644 index 00000000..b6bb8a40 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs @@ -0,0 +1,51 @@ +// 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 WixToolsetTest.Converters.Mocks +{ + using System; + using System.Collections.Generic; + using WixToolset.Extensibility.Services; + + public class MockCoreServiceProvider : IWixToolsetCoreServiceProvider + { + public Dictionary, object>> CreationFunctions { get; } = new Dictionary, object>>(); + + public Dictionary Singletons { get; } = new Dictionary() + { + { typeof(IMessaging), new MockMessaging() } + }; + + public void AddService(Type serviceType, Func, object> creationFunction) => this.CreationFunctions.Add(serviceType, creationFunction); + + public void AddService(Func, T> creationFunction) where T : class => this.AddService(typeof(T), creationFunction); + + public T GetService() where T : class => this.TryGetService(typeof(T), out var obj) ? (T)obj : null; + + public object GetService(Type serviceType) => this.TryGetService(serviceType, out var service) ? service : null; + + public bool TryGetService(Type serviceType, out object service) + { + if (!this.Singletons.TryGetValue(serviceType, out service)) + { + if (this.CreationFunctions.TryGetValue(serviceType, out var creationFunction)) + { + service = creationFunction(this, this.Singletons); + } + } + + return service != null; + } + + public bool TryGetService(out T service) where T : class + { + service = null; + + if (this.TryGetService(typeof(T), out var obj)) + { + service = (T)obj; + } + + return service != null; + } + } +} \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs b/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs new file mode 100644 index 00000000..8f7d4100 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs @@ -0,0 +1,40 @@ +// 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 WixToolsetTest.Converters.Mocks +{ + using System; + using System.Collections.Generic; + using System.Text; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + + public class MockMessaging : IMessaging + { + public List Messages { get; } = new List(); + + public bool EncounteredError { get; private set; } + + public int LastErrorNumber { get; } + + public bool ShowVerboseMessages { get; set; } + + public bool SuppressAllWarnings { get; set; } + + public bool WarningsAsError { get; set; } + + public void ElevateWarningMessage(int warningNumber) => throw new NotImplementedException(); + + public void SetListener(IMessageListener listener) => throw new NotImplementedException(); + + public void SuppressWarningMessage(int warningNumber) => throw new NotImplementedException(); + + public void Write(Message message) + { + this.Messages.Add(message); + this.EncounteredError |= message.Level == MessageLevel.Error; + } + + public void Write(string message, bool verbose = false) => throw new NotImplementedException(); + } +} diff --git a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs new file mode 100644 index 00000000..0e241544 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs new file mode 100644 index 00000000..375b70d3 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs new file mode 100644 index 00000000..dcd43e35 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs new file mode 100644 index 00000000..2eb908c2 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml new file mode 100644 index 00000000..9d3ad496 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs new file mode 100644 index 00000000..b0630f65 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs new file mode 100644 index 00000000..b28c94e4 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs new file mode 100644 index 00000000..8d81a758 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs new file mode 100644 index 00000000..99cc2151 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs new file mode 100644 index 00000000..aacb68fa --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs new file mode 100644 index 00000000..310ae811 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs @@ -0,0 +1,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 14546fd6..11ab5b3e 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -11,12 +11,27 @@ NU1701 + + + + + + + + + + + + + + + -- cgit v1.2.3-55-g6feb From 71e3338346841dcd31f18dd715cfa106b2a6e548 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Mon, 8 Jun 2020 16:19:45 -0700 Subject: Make convert code async --- src/WixToolset.Converters/ConvertCommand.cs | 16 ++++++++++------ .../ConverterIntegrationFixture.cs | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs index a684bc95..139b5813 100644 --- a/src/WixToolset.Converters/ConvertCommand.cs +++ b/src/WixToolset.Converters/ConvertCommand.cs @@ -5,6 +5,8 @@ namespace WixToolset.Converters using System; using System.Collections.Generic; using System.IO; + using System.Threading; + using System.Threading.Tasks; using System.Xml; using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; @@ -110,12 +112,12 @@ namespace WixToolset.Converters } } - public int Execute() + public Task ExecuteAsync(CancellationToken cancellationToken) { if (this.ShowHelp) { DisplayHelp(); - return 1; + return Task.FromResult(1); } // parse the settings if any were specified @@ -133,7 +135,7 @@ namespace WixToolset.Converters var converter = new Wix3Converter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); - var errors = this.InspectSubDirectories(converter, Path.GetFullPath(".")); + var errors = this.InspectSubDirectories(converter, Path.GetFullPath("."), cancellationToken); foreach (var searchPattern in this.SearchPatterns) { @@ -144,7 +146,7 @@ namespace WixToolset.Converters } } - return errors != 0 ? 2 : 0; + return Task.FromResult(errors != 0 ? 2 : 0); } private static void DisplayHelp() @@ -202,7 +204,7 @@ namespace WixToolset.Converters /// /// The directory whose sub-directories will be inspected. /// The number of errors that were found. - private int InspectSubDirectories(Wix3Converter converter, string directory) + private int InspectSubDirectories(Wix3Converter converter, string directory, CancellationToken cancellationToken) { var errors = 0; @@ -210,6 +212,8 @@ namespace WixToolset.Converters { foreach (var sourceFilePath in GetFiles(directory, searchPattern)) { + cancellationToken.ThrowIfCancellationRequested(); + var file = new FileInfo(sourceFilePath); if (!this.ExemptFiles.Contains(file.Name.ToUpperInvariant())) @@ -224,7 +228,7 @@ namespace WixToolset.Converters { foreach (var childDirectoryPath in Directory.GetDirectories(directory)) { - errors += this.InspectSubDirectories(converter, childDirectoryPath); + errors += this.InspectSubDirectories(converter, childDirectoryPath, cancellationToken); } } diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index 6138fd2b..860c195f 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -158,7 +158,7 @@ namespace WixToolsetTest.Converters targetFile }, serviceProvider, out var messages); - return new WixRunnerResult { ExitCode = exitCode, Messages = messages.ToArray() }; + return new WixRunnerResult { ExitCode = exitCode.Result, Messages = messages.ToArray() }; } private static void EnsureFixed(string targetFile) -- cgit v1.2.3-55-g6feb From b123126f6c3511259e4520cc7151e9dce9c534bc Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 12 Jun 2020 06:53:48 -0700 Subject: Extract common code to base class and use common mock messaging --- .../BaseConverterFixture.cs | 47 +++++++++++ .../WixToolsetTest.Converters/ConverterFixture.cs | 95 +++++----------------- .../Mocks/MockMessaging.cs | 1 - 3 files changed, 69 insertions(+), 74 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/BaseConverterFixture.cs (limited to 'src') diff --git a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs new file mode 100644 index 00000000..e8eeb459 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs @@ -0,0 +1,47 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Text; + using System.Xml.Linq; + using Xunit; + + public abstract class BaseConverterFixture + { + protected static string UnformattedDocumentString(XDocument document) + { + var sb = new StringBuilder(); + + using (var writer = new StringWriter(sb)) + { + document.Save(writer, SaveOptions.DisableFormatting); + } + + return sb.ToString(); + } + + protected static string[] UnformattedDocumentLines(XDocument document) + { + var sb = new StringBuilder(); + + using (var writer = new StringWriter(sb)) + { + document.Save(writer, SaveOptions.DisableFormatting); + } + + return sb.ToString().Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries); + } + + protected static void CompareLineByLine(string[] expectedLines, string[] actualLines) + { + for (var i = 0; i < expectedLines.Length; ++i) + { + Assert.True(actualLines.Length > i, $"{i}: Expected file longer than actual file"); + Assert.Equal($"{i}: {expectedLines[i]}", $"{i}: {actualLines[i]}"); + } + Assert.True(expectedLines.Length == actualLines.Length, "Actual file longer than expected file"); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index c6037787..7a39b0c6 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -3,16 +3,12 @@ namespace WixToolsetTest.Converters { using System; - using System.IO; - using System.Text; using System.Xml.Linq; using WixToolset.Converters; - using WixToolset.Data; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Services; + using WixToolsetTest.Converters.Mocks; using Xunit; - public class ConverterFixture + public class ConverterFixture : BaseConverterFixture { private static readonly XNamespace Wix4Namespace = "http://wixtoolset.org/schemas/v4/wxs"; @@ -32,7 +28,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -54,7 +50,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 4, null, null); var errors = converter.ConvertDocument(document); @@ -87,7 +83,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 4, null, null); var errors = converter.ConvertDocument(document); @@ -123,7 +119,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 4, null, null); var conversions = converter.ConvertDocument(document); @@ -161,7 +157,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 4, null, null); var conversions = converter.ConvertDocument(document); @@ -195,7 +191,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -231,7 +227,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -255,7 +251,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(0, errors); @@ -278,7 +274,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -307,7 +303,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -340,7 +336,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -370,7 +366,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -399,7 +395,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -438,7 +434,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -467,7 +463,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -495,7 +491,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -523,7 +519,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -551,7 +547,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -579,7 +575,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -613,7 +609,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - var messaging = new DummyMessaging(); + var messaging = new MockMessaging(); var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -623,52 +619,5 @@ namespace WixToolsetTest.Converters Assert.Equal(6, errors); Assert.Equal(expected, actual); } - - private static string UnformattedDocumentString(XDocument document) - { - var sb = new StringBuilder(); - - using (var writer = new StringWriter(sb)) - { - document.Save(writer, SaveOptions.DisableFormatting); - } - - return sb.ToString(); - } - - private class DummyMessaging : IMessaging - { - public bool EncounteredError { get; set; } - - public int LastErrorNumber { get; set; } - - public bool ShowVerboseMessages { get; set; } - - public bool SuppressAllWarnings { get; set; } - - public bool WarningsAsError { get; set; } - - public void ElevateWarningMessage(int warningNumber) - { - } - - public string FormatMessage(Message message) => String.Empty; - - public void SetListener(IMessageListener listener) - { - } - - public void SuppressWarningMessage(int warningNumber) - { - } - - public void Write(Message message) - { - } - - public void Write(string message, bool verbose = false) - { - } - } } } diff --git a/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs b/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs index 8f7d4100..77821a1c 100644 --- a/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs +++ b/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs @@ -4,7 +4,6 @@ namespace WixToolsetTest.Converters.Mocks { using System; using System.Collections.Generic; - using System.Text; using WixToolset.Data; using WixToolset.Extensibility; using WixToolset.Extensibility.Services; -- cgit v1.2.3-55-g6feb From 90bdfa6e06862030f6b255a4dcacb5871a35b1a1 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 12 Jun 2020 06:54:42 -0700 Subject: Convert custom table Column Category and Modularize attributes --- src/WixToolset.Converters/Wix3Converter.cs | 54 +++++++++++++++++++++- .../CustomTableFixture.cs | 50 ++++++++++++++++++++ 2 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 src/test/WixToolsetTest.Converters/CustomTableFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 66ccd9d3..559e5368 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -26,6 +26,7 @@ namespace WixToolset.Converters private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; + private static readonly XName ColumnElementName = WixNamespace + "Column"; private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; @@ -82,6 +83,7 @@ namespace WixToolset.Converters { this.ConvertElementMapping = new Dictionary> { + { Wix3Converter.ColumnElementName, this.ConvertColumnElement }, { Wix3Converter.CustomTableElementName, this.ConvertCustomTableElement }, { Wix3Converter.DirectoryElementName, this.ConvertDirectoryElement }, { Wix3Converter.FileElementName, this.ConvertFileElement }, @@ -298,6 +300,31 @@ namespace WixToolset.Converters } } + private void ConvertColumnElement(XElement element) + { + var category = element.Attribute("Category"); + if (category != null) + { + var camelCaseValue = LowercaseFirstChar(category.Value); + if (category.Value != camelCaseValue && + this.OnError(ConverterTestType.ColumnCategoryCamelCase, element, "The CustomTable Category attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", category.Name)) + { + category.Value = camelCaseValue; + } + } + + var modularization = element.Attribute("Modularize"); + if (modularization != null) + { + var camelCaseValue = LowercaseFirstChar(modularization.Value); + if (category.Value != camelCaseValue && + this.OnError(ConverterTestType.ColumnModularizeCamelCase, element, "The CustomTable Modularize attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", modularization.Name)) + { + modularization.Value = camelCaseValue; + } + } + } + private void ConvertCustomTableElement(XElement element) { var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); @@ -583,7 +610,7 @@ namespace WixToolset.Converters /// This is duplicated from WiX's Common class. private static string GetIdentifierFromName(string name) { - string result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + var result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". // MSI identifiers must begin with an alphabetic character or an // underscore. Prefix all other values with an underscore. @@ -595,6 +622,21 @@ namespace WixToolset.Converters return result; } + private static string LowercaseFirstChar(string value) + { + if (!String.IsNullOrEmpty(value)) + { + var c = Char.ToLowerInvariant(value[0]); + if (c != value[0]) + { + var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; + return c + remainder; + } + } + + return value; + } + /// /// Converter test types. These are used to condition error messages down to warnings. /// @@ -699,6 +741,16 @@ namespace WixToolset.Converters /// Inheritable is new and is now defaulted to 'yes' which is a change in behavior for all but children of CreateFolder. /// AssignPermissionExInheritable, + + /// + /// Column element's Category attribute is camel-case. + /// + ColumnCategoryCamelCase, + + /// + /// Column element's Modularize attribute is camel-case. + /// + ColumnModularizeCamelCase, } } } diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs new file mode 100644 index 00000000..5a572294 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -0,0 +1,50 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class CustomTableFixture : BaseConverterFixture + { + [Fact] + public void FixCustomTableCategoryAndModularization() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From f71718ee6481cda2cf6360968aaf21ee4c111ebd Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 13 Jun 2020 09:41:05 -0700 Subject: Consistently call IWixToolsetCoreServiceProvider a "coreProvider" --- .../WixToolsetCoreServiceProviderExtensions.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs index afc33f62..c5b7a27d 100644 --- a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs +++ b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs @@ -6,12 +6,12 @@ namespace WixToolset.Converters public static class WixToolsetCoreServiceProviderExtensions { - public static IWixToolsetCoreServiceProvider AddConverter(this IWixToolsetCoreServiceProvider serviceProvider) + public static IWixToolsetCoreServiceProvider AddConverter(this IWixToolsetCoreServiceProvider coreProvider) { - var extensionManager = serviceProvider.GetService(); + var extensionManager = coreProvider.GetService(); extensionManager.Add(typeof(ConverterExtensionFactory).Assembly); - return serviceProvider; + return coreProvider; } } } -- cgit v1.2.3-55-g6feb From 99cdb4f1d7829a2efb503881abe57033672c2b47 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Mon, 15 Jun 2020 22:13:50 +1000 Subject: Replace the removed Gaming namespace with the missing Http namespace. --- appveyor.cmd | 8 ++++---- src/WixToolset.Converters/Wix3Converter.cs | 2 +- src/WixToolset.Converters/WixToolset.Converters.csproj | 2 +- .../WixToolsetTest.Converters/WixToolsetTest.Converters.csproj | 1 + 4 files changed, 7 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/appveyor.cmd b/appveyor.cmd index 7c739df1..25eeca02 100644 --- a/appveyor.cmd +++ b/appveyor.cmd @@ -2,11 +2,11 @@ @pushd %~dp0 @set _P=%~dp0build\Release\publish -dotnet pack -c Release src\WixToolset.Converters -dotnet pack -c Release src\WixToolset.Converters.Tupleizer +dotnet pack -c Release src\WixToolset.Converters || exit /b +dotnet pack -c Release src\WixToolset.Converters.Tupleizer || exit /b -dotnet build -c Release src\test\WixToolsetTest.Converters -dotnet build -c Release src\test\WixToolsetTest.Converters.Tupleizer +dotnet build -c Release src\test\WixToolsetTest.Converters || exit /b +dotnet build -c Release src\test\WixToolsetTest.Converters.Tupleizer || exit /b @popd @endlocal diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 559e5368..9329bd13 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -49,7 +49,7 @@ namespace WixToolset.Converters { "http://schemas.microsoft.com/wix/DependencyExtension", "http://wixtoolset.org/schemas/v4/wxs/dependency" }, { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, - { "http://schemas.microsoft.com/wix/GamingExtension", "http://wixtoolset.org/schemas/v4/wxs/gaming" }, + { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, { "http://schemas.microsoft.com/wix/IIsExtension", "http://wixtoolset.org/schemas/v4/wxs/iis" }, { "http://schemas.microsoft.com/wix/MsmqExtension", "http://wixtoolset.org/schemas/v4/wxs/msmq" }, { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj index 1e443877..ad003e27 100644 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -16,7 +16,7 @@ - + diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 11ab5b3e..9f761738 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -31,6 +31,7 @@ + -- cgit v1.2.3-55-g6feb From 7987d2f7e2d47427d7571ab7cc3640d7b0bbb7ff Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 23 Jun 2020 00:58:11 -0700 Subject: Convert inner text to appropriate attributes --- src/WixToolset.Converters/Wix3Converter.cs | 280 ++++++++++++++++++++- .../WixToolsetTest.Converters/ConditionFixture.cs | 208 +++++++++++++++ .../WixToolsetTest.Converters/ConverterFixture.cs | 151 ----------- .../CustomActionFixture.cs | 90 +++++++ .../CustomTableFixture.cs | 145 +++++++++++ .../WixToolsetTest.Converters/PropertyFixture.cs | 114 +++++++++ .../WixToolsetTest.Converters/SequenceFixture.cs | 50 ++++ 7 files changed, 886 insertions(+), 152 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/ConditionFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/CustomActionFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/PropertyFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/SequenceFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 9329bd13..27c29e4d 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -26,16 +26,43 @@ namespace WixToolset.Converters private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; + private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; + private static readonly XName AdminUISequenceSequenceElementName = WixNamespace + "AdminUISequence"; + private static readonly XName AdvertiseExecuteSequenceElementName = WixNamespace + "AdvertiseExecuteSequence"; + private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; + private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; + private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; private static readonly XName ColumnElementName = WixNamespace + "Column"; + private static readonly XName ComponentElementName = WixNamespace + "Component"; + private static readonly XName ControlElementName = WixNamespace + "Control"; + private static readonly XName ConditionElementName = WixNamespace + "Condition"; private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; + private static readonly XName FeatureElementName = WixNamespace + "Feature"; private static readonly XName FileElementName = WixNamespace + "File"; + private static readonly XName FragmentElementName = WixNamespace + "Fragment"; + private static readonly XName ErrorElementName = WixNamespace + "Error"; + private static readonly XName LaunchElementName = WixNamespace + "Launch"; + private static readonly XName LevelElementName = WixNamespace + "Level"; private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; private static readonly XName PayloadElementName = WixNamespace + "Payload"; + private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; + private static readonly XName ProductElementName = WixNamespace + "Product"; + private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; + private static readonly XName PublishElementName = WixNamespace + "Publish"; + private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; + private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; + private static readonly XName RowElementName = WixNamespace + "Row"; + private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; + private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; + private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; + private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; + private static readonly XName TextElementName = WixNamespace + "Text"; + private static readonly XName UITextElementName = WixNamespace + "UIText"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; private static readonly XName PropertyElementName = WixNamespace + "Property"; @@ -83,16 +110,40 @@ namespace WixToolset.Converters { this.ConvertElementMapping = new Dictionary> { + { Wix3Converter.AdminExecuteSequenceElementName, this.ConvertSequenceElement }, + { Wix3Converter.AdminUISequenceSequenceElementName, this.ConvertSequenceElement }, + { Wix3Converter.AdvertiseExecuteSequenceElementName, this.ConvertSequenceElement }, + { Wix3Converter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, + { Wix3Converter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, { Wix3Converter.ColumnElementName, this.ConvertColumnElement }, { Wix3Converter.CustomTableElementName, this.ConvertCustomTableElement }, + { Wix3Converter.ControlElementName, this.ConvertControlElement }, + { Wix3Converter.ComponentElementName, this.ConvertComponentElement }, { Wix3Converter.DirectoryElementName, this.ConvertDirectoryElement }, + { Wix3Converter.FeatureElementName, this.ConvertFeatureElement }, { Wix3Converter.FileElementName, this.ConvertFileElement }, + { Wix3Converter.FragmentElementName, this.ConvertFragmentElement }, + { Wix3Converter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, + { Wix3Converter.ErrorElementName, this.ConvertErrorElement }, { Wix3Converter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.MsiPackageElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.MspPackageElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, { Wix3Converter.PayloadElementName, this.ConvertSuppressSignatureValidation }, + { Wix3Converter.PermissionExElementName, this.ConvertPermissionExElement }, + { Wix3Converter.ProductElementName, this.ConvertProductElement }, + { Wix3Converter.ProgressTextElementName, this.ConvertProgressTextElement }, + { Wix3Converter.PublishElementName, this.ConvertPublishElement }, + { Wix3Converter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, + { Wix3Converter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, + { Wix3Converter.RowElementName, this.ConvertRowElement }, { Wix3Converter.CustomActionElementName, this.ConvertCustomActionElement }, + { Wix3Converter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, + { Wix3Converter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, + { Wix3Converter.SetPropertyElementName, this.ConvertSetPropertyElement }, + { Wix3Converter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, + { Wix3Converter.TextElementName, this.ConvertTextElement }, + { Wix3Converter.UITextElementName, this.ConvertUITextElement }, { Wix3Converter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, { Wix3Converter.PropertyElementName, this.ConvertPropertyElement }, { Wix3Converter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, @@ -173,6 +224,8 @@ namespace WixToolset.Converters /// The number of errors found. public int ConvertDocument(XDocument document) { + this.Errors = 0; + var declaration = document.Declaration; // Convert the declaration. @@ -336,6 +389,36 @@ namespace WixToolset.Converters } } + private void ConvertControlElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var action = UppercaseFirstChar(xCondition.Attribute("Action")?.Value); + if (!String.IsNullOrEmpty(action) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}Condition' attribute instead.", xCondition.Name.LocalName, action)) + { + element.Add(new XAttribute(action + "Condition", text)); + xCondition.Remove(); + } + } + } + + private void ConvertComponentElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + if (TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) + { + element.Add(new XAttribute("Condition", text)); + xCondition.Remove(); + } + } + } + private void ConvertDirectoryElement(XElement element) { if (null == element.Attribute("Name")) @@ -353,6 +436,25 @@ namespace WixToolset.Converters } } + private void ConvertFeatureElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var level = xCondition.Attribute("Level")?.Value; + if (!String.IsNullOrEmpty(level) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Level' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LevelElementName, + new XAttribute("Value", level), + new XAttribute("Condition", text) + )); + xCondition.Remove(); + } + } + } + private void ConvertFileElement(XElement element) { if (null == element.Attribute("Id")) @@ -379,6 +481,90 @@ namespace WixToolset.Converters } } + private void ConvertFragmentElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var message = xCondition.Attribute("Message")?.Value; + + if (!String.IsNullOrEmpty(message) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LaunchElementName, + new XAttribute("Condition", text), + new XAttribute("Message", message) + )); + xCondition.Remove(); + } + } + } + + private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + + private void ConvertPermissionExElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + if (TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) + { + element.Add(new XAttribute("Condition", text)); + xCondition.Remove(); + } + } + } + + private void ConvertProgressTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + + private void ConvertProductElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var message = element.Attribute("Message")?.Value; + + if (!String.IsNullOrEmpty(message) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LaunchElementName, + new XAttribute("Condition", text), + new XAttribute("Message", message) + )); + xCondition.Remove(); + } + } + } + + private void ConvertPublishElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); + + private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSequenceElement(XElement element) + { + foreach (var child in element.Elements()) + { + this.ConvertInnerTextToAttribute(child, "Condition"); + } + } + + private void ConvertServiceArgumentElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSetDirectoryElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertSetPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertSuppressSignatureValidation(XElement element) { var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); @@ -397,6 +583,10 @@ namespace WixToolset.Converters } } + private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertCustomActionElement(XElement xCustomAction) { var xBinaryKey = xCustomAction.Attribute("BinaryKey"); @@ -436,6 +626,24 @@ namespace WixToolset.Converters xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); } } + + var xScript = xCustomAction.Attribute("Script"); + + if (xScript != null && TryGetInnerText(xCustomAction, out var scriptText)) + { + if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptFile' attribute to reference it.", xCustomAction.Name.LocalName)) + { + var scriptFolder = Path.GetDirectoryName(this.SourceFile) ?? String.Empty; + var id = xCustomAction.Attribute("Id")?.Value ?? Guid.NewGuid().ToString("N"); + var ext = (xScript.Value == "jscript") ? ".js" : (xScript.Value == "vbscript") ? ".vbs" : ".txt"; + + var scriptFile = Path.Combine(scriptFolder, id + ext); + File.WriteAllText(scriptFile, scriptText); + + RemoveChildren(xCustomAction); + xCustomAction.Add(new XAttribute("ScriptFile", scriptFile)); + } + } } private void ConvertPropertyElement(XElement xProperty) @@ -446,6 +654,8 @@ namespace WixToolset.Converters { this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); } + + this.ConvertInnerTextToAttribute(xProperty, "Value"); } private void ConvertUtilPermissionExElement(XElement element) @@ -483,13 +693,22 @@ namespace WixToolset.Converters } } + private void ConvertInnerTextToAttribute(XElement element, string attributeName) + { + if (TryGetInnerText(element, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}' attribute instead.", element.Name.LocalName, attributeName)) + { + element.Add(new XAttribute(attributeName, text)); + RemoveChildren(element); + } + } + private IEnumerable YieldConverterTypes(IEnumerable types) { if (null != types) { foreach (var type in types) { - if (Enum.TryParse(type, true, out var itt)) { yield return itt; @@ -637,6 +856,60 @@ namespace WixToolset.Converters return value; } + private static string UppercaseFirstChar(string value) + { + if (!String.IsNullOrEmpty(value)) + { + var c = Char.ToUpperInvariant(value[0]); + if (c != value[0]) + { + var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; + return c + remainder; + } + } + + return value; + } + + private static bool TryGetInnerText(XElement element, out string value) + { + value = null; + + var nodes = element.Nodes(); + + if (nodes.All(e => e.NodeType == XmlNodeType.Text || e.NodeType == XmlNodeType.CDATA)) + { + value = String.Join(String.Empty, nodes.Cast().Select(TrimTextValue)); + } + + return !String.IsNullOrEmpty(value); + } + + private static string TrimTextValue(XText text) + { + var value = text.Value; + + if (String.IsNullOrEmpty(value)) + { + return String.Empty; + } + else if (text.NodeType == XmlNodeType.CDATA && String.IsNullOrWhiteSpace(value)) + { + return " "; + } + + return value.Trim(); + } + + private static void RemoveChildren(XElement element) + { + var nodes = element.Nodes().ToList(); + foreach (var node in nodes) + { + node.Remove(); + } + } + /// /// Converter test types. These are used to condition error messages down to warnings. /// @@ -751,6 +1024,11 @@ namespace WixToolset.Converters /// Column element's Modularize attribute is camel-case. /// ColumnModularizeCamelCase, + + /// + /// Inner text value should move to an attribute. + /// + InnerTextDeprecated, } } } diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs new file mode 100644 index 00000000..bd7f52a8 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -0,0 +1,208 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ConditionFixture : BaseConverterFixture + { + [Fact] + public void FixControlCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " a<>b", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixComponentCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " 1<2", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixFeatureCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " PROP = 1", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixLaunchCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " 1<2", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPermissionExCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " 1<2", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 7a39b0c6..3378b804 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -168,95 +168,6 @@ namespace WixToolsetTest.Converters Assert.Equal(3, conversions); } - [Fact] - public void CanFixCdataWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(2, errors); - } - - [Fact] - public void CanFixCdataWithWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(2, errors); - } - - [Fact] - public void CanKeepCdataWithOnlyWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); - var errors = converter.ConvertDocument(document); - Assert.Equal(0, errors); - } - [Fact] public void CanConvertMainNamespace() { @@ -474,34 +385,6 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } - [Fact] - public void CanConvertCustomTableBootstrapperApplicationData() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - [Fact] public void CanConvertShortNameDirectoryWithoutName() { @@ -585,39 +468,5 @@ namespace WixToolsetTest.Converters Assert.Equal(1, errors); Assert.Equal(expected, actual); } - - [Fact] - public void CanConvertCustomAction() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(6, errors); - Assert.Equal(expected, actual); - } } } diff --git a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs new file mode 100644 index 00000000..1eab0926 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs @@ -0,0 +1,90 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class CustomActionFixture : BaseConverterFixture + { + [Fact] + public void CanConvertCustomAction() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(6, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertCustomActionScript() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " function() {", + " var x = 0;", + " return x;", + " }", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expectedScript = String.Join("\n", + "function() {", + " var x = 0;", + " return x;", + " }"); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + + var script = File.ReadAllText("Foo.js"); + Assert.Equal(expectedScript, script); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs index 5a572294..c09534ee 100644 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -46,5 +46,150 @@ namespace WixToolsetTest.Converters var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); } + + [Fact] + public void FixCustomRowTextValue() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " Some value", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixCustomRowCdataValue() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixCustomRowWithoutValue() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(2, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CanConvertCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } } } diff --git a/src/test/WixToolsetTest.Converters/PropertyFixture.cs b/src/test/WixToolsetTest.Converters/PropertyFixture.cs new file mode 100644 index 00000000..0449fb43 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/PropertyFixture.cs @@ -0,0 +1,114 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class PropertyFixture : BaseConverterFixture + { + [Fact] + public void CanFixCdataWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(1, errors); + } + + [Fact] + public void CanFixCdataWithWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(1, errors); + } + + [Fact] + public void CanKeepCdataWithOnlyWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(1, errors); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/SequenceFixture.cs b/src/test/WixToolsetTest.Converters/SequenceFixture.cs new file mode 100644 index 00000000..997dcd6a --- /dev/null +++ b/src/test/WixToolsetTest.Converters/SequenceFixture.cs @@ -0,0 +1,50 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class SequenceFixture : BaseConverterFixture + { + [Fact] + public void FixCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " NOT Installed", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new Wix3Converter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 9c235551b2fb961cf10ecb307c252fd5de377513 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 23 Jun 2020 01:11:19 -0700 Subject: Remove explicit auto-GUIDs --- src/WixToolset.Converters/Wix3Converter.cs | 23 ++++++++++++++++++++++ .../WixToolsetTest.Converters/ConditionFixture.cs | 4 ++-- .../ConverterIntegrationFixture.cs | 2 +- .../Preprocessor/ConvertedPreprocessor.wxs | 2 +- .../TestData/QtExec.bad/v4_expected.wxs | 2 +- .../TestData/QtExec/v4_expected.wxs | 2 +- .../TestData/SingleFile/ConvertedSingleFile.wxs | 2 +- 7 files changed, 30 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 27c29e4d..2d603c4f 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -407,6 +407,15 @@ namespace WixToolset.Converters private void ConvertComponentElement(XElement element) { + var guid = element.Attribute("Guid"); + if (guid != null && guid.Value == "*") + { + if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Component Guid attribute is unnecessary. Remove the attribute to remove the redundancy.")) + { + guid.Remove(); + } + } + var xCondition = element.Element(ConditionElementName); if (xCondition != null) { @@ -523,6 +532,15 @@ namespace WixToolset.Converters private void ConvertProductElement(XElement element) { + var id = element.Attribute("Id"); + if (id != null && id.Value == "*") + { + if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Product Id attribute is unnecessary. Remove the attribute to remove the redundancy.")) + { + id.Remove(); + } + } + var xCondition = element.Element(ConditionElementName); if (xCondition != null) { @@ -1029,6 +1047,11 @@ namespace WixToolset.Converters /// Inner text value should move to an attribute. /// InnerTextDeprecated, + + /// + /// Explicit auto-GUID unnecessary. + /// + AutoGuidUnnecessary, } } } diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index bd7f52a8..6a5ce1f9 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -171,7 +171,7 @@ namespace WixToolsetTest.Converters "", "", " ", - " ", + " ", " ", " 1<2", " ", @@ -199,7 +199,7 @@ namespace WixToolsetTest.Converters var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); + Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index 860c195f..d05f8e8f 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -58,7 +58,7 @@ namespace WixToolsetTest.Converters var converter = new Wix3Converter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); - Assert.Equal(5, errors); + Assert.Equal(6, errors); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs index dcd43e35..72c78653 100644 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -6,7 +6,7 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs index b28c94e4..20a5b1d0 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -6,7 +6,7 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs index 99cc2151..cb42ea7d 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -6,7 +6,7 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs index aacb68fa..0c4fd1fb 100644 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -6,7 +6,7 @@ - + -- cgit v1.2.3-55-g6feb From acba90f005779fa03ee05c3c87148bb6141ba60e Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 23 Jun 2020 16:43:11 -0700 Subject: Do *not* require XML declaration --- src/WixToolset.Converters/Wix3Converter.cs | 48 +++++++++++------ .../BaseConverterFixture.cs | 16 +++--- .../WixToolsetTest.Converters/ConditionFixture.cs | 10 ++-- .../WixToolsetTest.Converters/ConverterFixture.cs | 61 +++++----------------- .../ConverterIntegrationFixture.cs | 2 +- .../CustomActionFixture.cs | 6 +-- .../CustomTableFixture.cs | 9 +--- .../WixToolsetTest.Converters/PropertyFixture.cs | 6 --- .../WixToolsetTest.Converters/SequenceFixture.cs | 4 +- .../TestData/PermissionEx/v3.wxs | 1 - .../TestData/PermissionEx/v4_expected.wxs | 1 - .../Preprocessor/ConvertedPreprocessor.wxs | 1 - .../TestData/QtExec.bad/v3.wxs | 1 - .../TestData/QtExec.bad/v4_expected.wxs | 1 - .../TestData/QtExec/v4_expected.wxs | 1 - .../TestData/SingleFile/ConvertedSingleFile.wxs | 1 - 16 files changed, 58 insertions(+), 111 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs index 2d603c4f..8c7d2049 100644 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ b/src/WixToolset.Converters/Wix3Converter.cs @@ -203,9 +203,9 @@ namespace WixToolset.Converters { try { - using (var writer = File.CreateText(this.SourceFile)) + using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = true })) { - document.Save(writer, SaveOptions.DisableFormatting | SaveOptions.OmitDuplicateNamespaces); + document.Save(writer); } } catch (UnauthorizedAccessException) @@ -228,26 +228,17 @@ namespace WixToolset.Converters var declaration = document.Declaration; - // Convert the declaration. + // Remove the declaration. if (null != declaration) { - if (!String.Equals("utf-8", declaration.Encoding, StringComparison.OrdinalIgnoreCase)) + if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) { - if (this.OnError(ConverterTestType.DeclarationEncodingWrong, document.Root, "The XML declaration encoding is not properly set to 'utf-8'.")) - { - declaration.Encoding = "utf-8"; - } - } - } - else // missing declaration - { - if (this.OnError(ConverterTestType.DeclarationMissing, null, "This file is missing an XML declaration on the first line.")) - { - document.Declaration = new XDeclaration("1.0", "utf-8", null); - document.Root.AddBeforeSelf(new XText(XDocumentNewLine.ToString())); + document.Declaration = null; } } + TrimLeadingText(document); + // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); @@ -903,6 +894,26 @@ namespace WixToolset.Converters return !String.IsNullOrEmpty(value); } + private static bool IsTextNode(XNode node, out XText text) + { + text = null; + + if (node.NodeType == XmlNodeType.Text || node.NodeType == XmlNodeType.CDATA) + { + text = (XText)node; + } + + return text != null; + } + + private static void TrimLeadingText(XDocument document) + { + while (IsTextNode(document.Nodes().FirstOrDefault(), out var text)) + { + text.Remove(); + } + } + private static string TrimTextValue(XText text) { var value = text.Value; @@ -1052,6 +1063,11 @@ namespace WixToolset.Converters /// Explicit auto-GUID unnecessary. /// AutoGuidUnnecessary, + + /// + /// Displayed when the XML declaration is present in the source file. + /// + DeclarationPresent, } } } diff --git a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs index e8eeb459..2cd4119b 100644 --- a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs @@ -5,6 +5,7 @@ namespace WixToolsetTest.Converters using System; using System.IO; using System.Text; + using System.Xml; using System.Xml.Linq; using Xunit; @@ -15,23 +16,18 @@ namespace WixToolsetTest.Converters var sb = new StringBuilder(); using (var writer = new StringWriter(sb)) + using (var xml = XmlWriter.Create(writer, new XmlWriterSettings { OmitXmlDeclaration = true })) { - document.Save(writer, SaveOptions.DisableFormatting); + document.Save(xml); } - return sb.ToString(); + return sb.ToString().TrimStart(); } protected static string[] UnformattedDocumentLines(XDocument document) { - var sb = new StringBuilder(); - - using (var writer = new StringWriter(sb)) - { - document.Save(writer, SaveOptions.DisableFormatting); - } - - return sb.ToString().Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries); + var unformatted = UnformattedDocumentString(document); + return unformatted.Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries); } protected static void CompareLineByLine(string[] expectedLines, string[] actualLines) diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 6a5ce1f9..804ebe5b 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -29,7 +29,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -70,7 +69,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -107,7 +105,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -144,7 +141,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -168,7 +164,7 @@ namespace WixToolsetTest.Converters public void FixPermissionExCondition() { var parse = String.Join(Environment.NewLine, - "", + "", "", " ", " ", @@ -181,7 +177,7 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", + "", "", " ", " ", @@ -199,7 +195,7 @@ namespace WixToolsetTest.Converters var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); + Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 3378b804..10029090 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -13,15 +13,15 @@ namespace WixToolsetTest.Converters private static readonly XNamespace Wix4Namespace = "http://wixtoolset.org/schemas/v4/wxs"; [Fact] - public void EnsuresDeclaration() + public void EnsuresNoDeclaration() { var parse = String.Join(Environment.NewLine, + "", "", " ", ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -39,27 +39,6 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } - [Fact] - public void EnsuresUtf8Declaration() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 4, null, null); - - var errors = converter.ConvertDocument(document); - - Assert.Equal(1, errors); - Assert.Equal("1.0", document.Declaration.Version); - Assert.Equal("utf-8", document.Declaration.Encoding); - } - [Fact] public void CanFixWhitespace() { @@ -74,7 +53,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -91,7 +69,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); Assert.Equal(expected, actual); - Assert.Equal(4, errors); + Assert.Equal(5, errors); } [Fact] @@ -108,7 +86,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", "", @@ -127,14 +104,13 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); Assert.Equal(expected, actual); - Assert.Equal(3, conversions); + Assert.Equal(4, conversions); } [Fact] public void CanConvertWithNewLineAtEndOfFile() { var parse = String.Join(Environment.NewLine, - "", "", " ", "", @@ -145,7 +121,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", "", @@ -178,7 +153,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -192,7 +166,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); //Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); Assert.Equal(expected, actual); } @@ -207,7 +181,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -221,7 +194,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); Assert.Equal(expected, actual); Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); } @@ -238,7 +211,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -255,7 +227,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); Assert.Equal(expected, actual); - Assert.Equal(2, errors); + Assert.Equal(3, errors); Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); Assert.Equal("http://wixtoolset.org/schemas/v4/wxs/util", document.Root.GetDefaultNamespace()); } @@ -270,7 +242,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -284,7 +255,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(2, errors); + Assert.Equal(3, errors); Assert.Equal(expected, actual); Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); } @@ -299,7 +270,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -313,7 +283,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); Assert.Equal(expected, actual); Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); } @@ -333,7 +303,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -352,7 +321,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); Assert.Equal(expected, actual); Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); } @@ -367,7 +336,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -381,7 +349,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); Assert.Equal(expected, actual); } @@ -395,7 +363,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -409,7 +376,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); Assert.Equal(expected, actual); } @@ -417,13 +384,11 @@ namespace WixToolsetTest.Converters public void CanConvertSuppressSignatureValidationNo() { var parse = String.Join(Environment.NewLine, - "", "", " ", ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -445,13 +410,11 @@ namespace WixToolsetTest.Converters public void CanConvertSuppressSignatureValidationYes() { var parse = String.Join(Environment.NewLine, - "", "", " ", ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index d05f8e8f..d4fd1acf 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -58,7 +58,7 @@ namespace WixToolsetTest.Converters var converter = new Wix3Converter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); - Assert.Equal(6, errors); + Assert.Equal(7, errors); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); diff --git a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs index 1eab0926..27d45bc6 100644 --- a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs @@ -24,7 +24,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -41,7 +40,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(6, errors); + Assert.Equal(7, errors); Assert.Equal(expected, actual); } @@ -60,7 +59,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); @@ -80,7 +78,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(1, errors); + Assert.Equal(2, errors); Assert.Equal(expected, actual); var script = File.ReadAllText("Foo.js"); diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs index c09534ee..b61dbb10 100644 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -25,7 +25,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -64,7 +63,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -90,7 +88,6 @@ namespace WixToolsetTest.Converters public void FixCustomRowCdataValue() { var parse = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -105,7 +102,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -121,7 +117,7 @@ namespace WixToolsetTest.Converters var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); + Assert.Equal(2, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); @@ -142,7 +138,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -168,13 +163,11 @@ namespace WixToolsetTest.Converters public void CanConvertCustomTableBootstrapperApplicationData() { var parse = String.Join(Environment.NewLine, - "", "", " ", ""); var expected = String.Join(Environment.NewLine, - "", "", " ", ""); diff --git a/src/test/WixToolsetTest.Converters/PropertyFixture.cs b/src/test/WixToolsetTest.Converters/PropertyFixture.cs index 0449fb43..90c1e5c9 100644 --- a/src/test/WixToolsetTest.Converters/PropertyFixture.cs +++ b/src/test/WixToolsetTest.Converters/PropertyFixture.cs @@ -14,7 +14,6 @@ namespace WixToolsetTest.Converters public void CanFixCdataWhitespace() { var parse = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -24,7 +23,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -48,7 +46,6 @@ namespace WixToolsetTest.Converters public void CanFixCdataWithWhitespace() { var parse = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -60,7 +57,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -84,7 +80,6 @@ namespace WixToolsetTest.Converters public void CanKeepCdataWithOnlyWhitespace() { var parse = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -92,7 +87,6 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", "", " ", " ", diff --git a/src/test/WixToolsetTest.Converters/SequenceFixture.cs b/src/test/WixToolsetTest.Converters/SequenceFixture.cs index 997dcd6a..1abe6c0c 100644 --- a/src/test/WixToolsetTest.Converters/SequenceFixture.cs +++ b/src/test/WixToolsetTest.Converters/SequenceFixture.cs @@ -14,7 +14,6 @@ namespace WixToolsetTest.Converters public void FixCondition() { var parse = String.Join(Environment.NewLine, - "", "", " ", " ", @@ -25,7 +24,6 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", "", " ", " ", @@ -41,7 +39,7 @@ namespace WixToolsetTest.Converters var converter = new Wix3Converter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); + Assert.Equal(2, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs index 0e241544..9a739052 100644 --- a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs @@ -1,4 +1,3 @@ - diff --git a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs index 375b70d3..6bf3c1ea 100644 --- a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs @@ -1,4 +1,3 @@ - diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs index 72c78653..ea52c71f 100644 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -1,4 +1,3 @@ - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs index b0630f65..b0fcf9c9 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs @@ -1,4 +1,3 @@ - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs index 20a5b1d0..02a06cff 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -1,4 +1,3 @@ - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs index cb42ea7d..00ce8461 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -1,4 +1,3 @@ - diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs index 0c4fd1fb..ec4d84d5 100644 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -1,4 +1,3 @@ - -- cgit v1.2.3-55-g6feb From 0e1b04018fc918d1a1c09a49363cb321cd68fe60 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Thu, 25 Jun 2020 15:37:28 -0700 Subject: The Great Tuple to Symbol Rename (tm) --- WixToolset.Converters.sln | 4 +- appveyor.cmd | 4 +- .../ConvertTuples.cs | 814 +++++++++++++++++++++ .../WixToolset.Converters.Symbolizer.csproj | 34 + .../ConvertTuples.cs | 814 --------------------- .../WixToolset.Converters.Tupleizer.csproj | 34 - .../ConvertTuplesFixture.cs | 606 +++++++++++++++ .../TestData/Integration/test.wixout | Bin 0 -> 148559 bytes .../TestData/Integration/test.wixproj | 47 ++ .../TestData/Integration/test.wxs | 36 + .../WixToolsetTest.Converters.Symbolizer.csproj | 33 + ...setTest.Converters.Symbolizer.v3.ncrunchproject | 9 + .../ConvertTuplesFixture.cs | 606 --------------- .../TestData/Integration/test.wixout | Bin 148559 -> 0 bytes .../TestData/Integration/test.wixproj | 47 -- .../TestData/Integration/test.wxs | 36 - .../WixToolsetTest.Converters.Tupleizer.csproj | 33 - ...lsetTest.Converters.Tupleizer.v3.ncrunchproject | 9 - 18 files changed, 1583 insertions(+), 1583 deletions(-) create mode 100644 src/WixToolset.Converters.Symbolizer/ConvertTuples.cs create mode 100644 src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj delete mode 100644 src/WixToolset.Converters.Tupleizer/ConvertTuples.cs delete mode 100644 src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject delete mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout delete mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj delete mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs delete mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj delete mode 100644 src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject (limited to 'src') diff --git a/WixToolset.Converters.sln b/WixToolset.Converters.sln index 5d26846e..a67df266 100644 --- a/WixToolset.Converters.sln +++ b/WixToolset.Converters.sln @@ -5,13 +5,13 @@ VisualStudioVersion = 15.0.26124.0 MinimumVisualStudioVersion = 15.0.26124.0 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters", "src\WixToolset.Converters\WixToolset.Converters.csproj", "{6FAF6385-6598-4B89-972B-C31AFCA14538}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters.Tupleizer", "src\WixToolset.Converters.Tupleizer\WixToolset.Converters.Tupleizer.csproj", "{F051BCAF-698C-41D5-8427-164537CE5C5C}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters.Symbolizer", "src\WixToolset.Converters.Symbolizer\WixToolset.Converters.Symbolizer.csproj", "{F051BCAF-698C-41D5-8427-164537CE5C5C}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters", "src\test\WixToolsetTest.Converters\WixToolsetTest.Converters.csproj", "{485C5038-97E1-4729-A54D-848CC69569FD}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters.Tupleizer", "src\test\WixToolsetTest.Converters.Tupleizer\WixToolsetTest.Converters.Tupleizer.csproj", "{9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters.Symbolizer", "src\test\WixToolsetTest.Converters.Symbolizer\WixToolsetTest.Converters.Symbolizer.csproj", "{9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/appveyor.cmd b/appveyor.cmd index 25eeca02..1b0040a3 100644 --- a/appveyor.cmd +++ b/appveyor.cmd @@ -3,10 +3,10 @@ @set _P=%~dp0build\Release\publish dotnet pack -c Release src\WixToolset.Converters || exit /b -dotnet pack -c Release src\WixToolset.Converters.Tupleizer || exit /b +dotnet pack -c Release src\WixToolset.Converters.Symbolizer || exit /b dotnet build -c Release src\test\WixToolsetTest.Converters || exit /b -dotnet build -c Release src\test\WixToolsetTest.Converters.Tupleizer || exit /b +dotnet build -c Release src\test\WixToolsetTest.Converters.Symbolizer || exit /b @popd @endlocal diff --git a/src/WixToolset.Converters.Symbolizer/ConvertTuples.cs b/src/WixToolset.Converters.Symbolizer/ConvertTuples.cs new file mode 100644 index 00000000..76a0440f --- /dev/null +++ b/src/WixToolset.Converters.Symbolizer/ConvertTuples.cs @@ -0,0 +1,814 @@ +// 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.Converters.Symbolizer +{ + using System; + using System.Collections.Generic; + using System.Linq; + using WixToolset.Data; + using WixToolset.Data.Symbols; + using WixToolset.Data.WindowsInstaller; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + + public static class ConvertSymbols + { + public static Intermediate ConvertFile(string path) + { + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + return ConvertOutput(output); + } + + public static Intermediate ConvertOutput(Wix3.Output output) + { + var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); + + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + var componentsById = IndexById(output, "Component"); + var bindPathsById = IndexById(output, "BindPath"); + var fontsById = IndexById(output, "Font"); + var selfRegById = IndexById(output, "SelfReg"); + var wixDirectoryById = IndexById(output, "WixDirectory"); + var wixFileById = IndexById(output, "WixFile"); + + foreach (Wix3.Table table in output.Tables) + { + foreach (Wix3.Row row in table.Rows) + { + var symbol = GenerateSymbolFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); + if (symbol != null) + { + section.Symbols.Add(symbol); + } + } + } + + return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add(FieldAsInt(row, 0), row); + } + } + + return wixMediaByDiskId; + } + + private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row + { + var byId = new Dictionary(); + var table = output.Tables[tableName]; + + if (table != null) + { + foreach (T row in table.Rows) + { + byId.Add(FieldAsString(row, 0), row); + } + } + + return byId; + } + + private static IntermediateSymbol GenerateSymbolFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) + { + var name = row.Table.Name; + switch (name) + { + case "_SummaryInformation": + return DefaultSymbolFromRow(typeof(SummaryInformationSymbol), row, columnZeroIsId: false); + case "ActionText": + return DefaultSymbolFromRow(typeof(ActionTextSymbol), row, columnZeroIsId: false); + case "AppId": + return DefaultSymbolFromRow(typeof(AppIdSymbol), row, columnZeroIsId: false); + case "AppSearch": + return DefaultSymbolFromRow(typeof(AppSearchSymbol), row, columnZeroIsId: false); + case "Billboard": + return DefaultSymbolFromRow(typeof(BillboardSymbol), row, columnZeroIsId: true); + case "Binary": + return DefaultSymbolFromRow(typeof(BinarySymbol), row, columnZeroIsId: true); + case "BindPath": + return null; + case "CCPSearch": + return DefaultSymbolFromRow(typeof(CCPSearchSymbol), row, columnZeroIsId: true); + case "Class": + return DefaultSymbolFromRow(typeof(ClassSymbol), row, columnZeroIsId: false); + case "CompLocator": + return DefaultSymbolFromRow(typeof(CompLocatorSymbol), row, columnZeroIsId: false); + case "Component": + { + var attributes = FieldAsNullableInt(row, 3); + + var location = ComponentLocation.LocalOnly; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) + { + location = ComponentLocation.SourceOnly; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) + { + location = ComponentLocation.Either; + } + + var keyPath = FieldAsString(row, 5); + var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) + { + keyPathType = ComponentKeyPathType.Registry; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) + { + keyPathType = ComponentKeyPathType.OdbcDataSource; + } + + return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentId = FieldAsString(row, 1), + DirectoryRef = FieldAsString(row, 2), + Condition = FieldAsString(row, 4), + KeyPath = keyPath, + Location = location, + DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, + NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, + Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, + SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, + Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, + Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, + UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, + Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, + KeyPathType = keyPathType, + }; + } + + case "Condition": + return DefaultSymbolFromRow(typeof(ConditionSymbol), row, columnZeroIsId: false); + case "CreateFolder": + return DefaultSymbolFromRow(typeof(CreateFolderSymbol), row, columnZeroIsId: false); + case "CustomAction": + { + var caType = FieldAsInt(row, 1); + var executionType = DetermineCustomActionExecutionType(caType); + var sourceType = DetermineCustomActionSourceType(caType); + var targetType = DetermineCustomActionTargetType(caType); + + return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ExecutionType = executionType, + SourceType = sourceType, + Source = FieldAsString(row, 2), + TargetType = targetType, + Target = FieldAsString(row, 3), + Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, + TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, + Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, + IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, + Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, + Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, + }; + } + + case "Directory": + { + var id = FieldAsString(row, 0); + var splits = SplitDefaultDir(FieldAsString(row, 2)); + + var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ParentDirectoryRef = FieldAsString(row, 1), + Name = splits[0], + ShortName = splits[1], + SourceName = splits[2], + SourceShortName = splits[3] + }; + + if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) + { + symbol.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); + } + + return symbol; + } + case "DrLocator": + return DefaultSymbolFromRow(typeof(DrLocatorSymbol), row, columnZeroIsId: false); + case "DuplicateFile": + return DefaultSymbolFromRow(typeof(DuplicateFileSymbol), row, columnZeroIsId: true); + case "Error": + return DefaultSymbolFromRow(typeof(ErrorSymbol), row, columnZeroIsId: false); + case "Extension": + return DefaultSymbolFromRow(typeof(ExtensionSymbol), row, columnZeroIsId: false); + case "Feature": + { + var attributes = FieldAsInt(row, 7); + var installDefault = FeatureInstallDefault.Local; + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) + { + installDefault = FeatureInstallDefault.FollowParent; + } + else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) + { + installDefault = FeatureInstallDefault.Source; + } + + return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ParentFeatureRef = FieldAsString(row, 1), + Title = FieldAsString(row, 2), + Description = FieldAsString(row, 3), + Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), + Level = FieldAsInt(row, 5), + DirectoryRef = FieldAsString(row, 6), + DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, + DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, + InstallDefault = installDefault, + TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, + }; + } + + case "FeatureComponents": + return DefaultSymbolFromRow(typeof(FeatureComponentsSymbol), row, columnZeroIsId: false); + case "File": + { + var attributes = FieldAsNullableInt(row, 6); + + FileSymbolAttributes symbolAttributes = 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileSymbolAttributes.ReadOnly : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileSymbolAttributes.Hidden : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileSymbolAttributes.System : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileSymbolAttributes.Vital : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileSymbolAttributes.Checksum : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileSymbolAttributes.Uncompressed : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileSymbolAttributes.Compressed : 0; + + var id = FieldAsString(row, 0); + + var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ComponentRef = FieldAsString(row, 1), + Name = FieldAsString(row, 2), + FileSize = FieldAsInt(row, 3), + Version = FieldAsString(row, 4), + Language = FieldAsString(row, 5), + Attributes = symbolAttributes + }; + + if (bindPathsById.TryGetValue(id, out var bindPathRow)) + { + symbol.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; + } + + if (fontsById.TryGetValue(id, out var fontRow)) + { + symbol.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; + } + + if (selfRegById.TryGetValue(id, out var selfRegRow)) + { + symbol.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; + } + + if (wixFileById.TryGetValue(id, out var wixFileRow)) + { + symbol.DirectoryRef = FieldAsString(wixFileRow, 4); + symbol.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; + symbol.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; + symbol.PatchGroup = FieldAsInt(wixFileRow, 8); + symbol.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileSymbolAttributes.GeneratedShortFileName : 0; + symbol.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); + } + + return symbol; + } + case "Font": + return null; + case "Icon": + return DefaultSymbolFromRow(typeof(IconSymbol), row, columnZeroIsId: true); + case "IniLocator": + return DefaultSymbolFromRow(typeof(IniLocatorSymbol), row, columnZeroIsId: false); + case "LockPermissions": + return DefaultSymbolFromRow(typeof(LockPermissionsSymbol), row, columnZeroIsId: false); + case "Media": + { + var diskId = FieldAsInt(row, 0); + var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) + { + DiskId = diskId, + LastSequence = FieldAsNullableInt(row, 1), + DiskPrompt = FieldAsString(row, 2), + Cabinet = FieldAsString(row, 3), + VolumeLabel = FieldAsString(row, 4), + Source = FieldAsString(row, 5) + }; + + if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) + { + var compressionLevel = FieldAsString(wixMediaRow, 1); + + symbol.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); + symbol.Layout = wixMediaRow.Layout; + } + + return symbol; + } + case "MIME": + return DefaultSymbolFromRow(typeof(MIMESymbol), row, columnZeroIsId: false); + case "ModuleIgnoreTable": + return DefaultSymbolFromRow(typeof(ModuleIgnoreTableSymbol), row, columnZeroIsId: true); + case "MoveFile": + return DefaultSymbolFromRow(typeof(MoveFileSymbol), row, columnZeroIsId: true); + case "MsiAssembly": + { + var componentId = FieldAsString(row, 0); + if (componentsById.TryGetValue(componentId, out var componentRow)) + { + return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) + { + ComponentRef = componentId, + FeatureRef = FieldAsString(row, 1), + ManifestFileRef = FieldAsString(row, 2), + ApplicationFileRef = FieldAsString(row, 3), + Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, + }; + } + + return null; + } + case "MsiLockPermissionsEx": + return DefaultSymbolFromRow(typeof(MsiLockPermissionsExSymbol), row, columnZeroIsId: true); + case "MsiShortcutProperty": + return DefaultSymbolFromRow(typeof(MsiShortcutPropertySymbol), row, columnZeroIsId: true); + case "ODBCDataSource": + return DefaultSymbolFromRow(typeof(ODBCDataSourceSymbol), row, columnZeroIsId: true); + case "ODBCDriver": + return DefaultSymbolFromRow(typeof(ODBCDriverSymbol), row, columnZeroIsId: true); + case "ODBCTranslator": + return DefaultSymbolFromRow(typeof(ODBCTranslatorSymbol), row, columnZeroIsId: true); + case "ProgId": + return DefaultSymbolFromRow(typeof(ProgIdSymbol), row, columnZeroIsId: false); + case "Property": + return DefaultSymbolFromRow(typeof(PropertySymbol), row, columnZeroIsId: true); + case "PublishComponent": + return DefaultSymbolFromRow(typeof(PublishComponentSymbol), row, columnZeroIsId: false); + case "Registry": + { + var value = FieldAsString(row, 4); + var valueType = RegistryValueType.String; + var valueAction = RegistryValueActionType.Write; + + if (!String.IsNullOrEmpty(value)) + { + if (value.StartsWith("#x", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Binary; + value = value.Substring(2); + } + else if (value.StartsWith("#%", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Expandable; + value = value.Substring(2); + } + else if (value.StartsWith("#", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Integer; + value = value.Substring(1); + } + else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3, value.Length - 6); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Write; + } + else if (value.StartsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Append; + } + else if (value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(0, value.Length - 3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Prepend; + } + } + + return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Value = value, + ComponentRef = FieldAsString(row, 5), + ValueAction = valueAction, + ValueType = valueType, + }; + } + case "RegLocator": + { + var type = FieldAsInt(row, 4); + + return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Type = (RegLocatorType)(type & 0xF), + Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit + }; + } + case "RemoveFile": + { + var installMode = FieldAsInt(row, 4); + return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileName = FieldAsString(row, 2), + DirProperty = FieldAsString(row, 3), + OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, + OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null + }; + } + case "RemoveRegistry": + { + return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Action = RemoveRegistryActionType.RemoveOnInstall, + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + ComponentRef = FieldAsString(row, 4), + }; + } + + case "ReserveCost": + return DefaultSymbolFromRow(typeof(ReserveCostSymbol), row, columnZeroIsId: true); + case "SelfReg": + return null; + case "ServiceControl": + { + var events = FieldAsInt(row, 2); + var wait = FieldAsNullableInt(row, 4); + return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Name = FieldAsString(row, 1), + Arguments = FieldAsString(row, 3), + Wait = !wait.HasValue || wait.Value == 1, + ComponentRef = FieldAsString(row, 5), + InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, + UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, + InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, + UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, + InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, + UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, + }; + } + + case "ServiceInstall": + return DefaultSymbolFromRow(typeof(ServiceInstallSymbol), row, columnZeroIsId: true); + case "Shortcut": + { + var splitName = FieldAsString(row, 2).Split('|'); + + return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + DirectoryRef = FieldAsString(row, 1), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, + ComponentRef = FieldAsString(row, 3), + Target = FieldAsString(row, 4), + Arguments = FieldAsString(row, 5), + Description = FieldAsString(row, 6), + Hotkey = FieldAsNullableInt(row, 7), + IconRef = FieldAsString(row, 8), + IconIndex = FieldAsNullableInt(row, 9), + Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), + WorkingDirectory = FieldAsString(row, 11), + DisplayResourceDll = FieldAsString(row, 12), + DisplayResourceId = FieldAsNullableInt(row, 13), + DescriptionResourceDll = FieldAsString(row, 14), + DescriptionResourceId= FieldAsNullableInt(row, 15), + }; + } + case "Signature": + return DefaultSymbolFromRow(typeof(SignatureSymbol), row, columnZeroIsId: true); + case "UIText": + return DefaultSymbolFromRow(typeof(UITextSymbol), row, columnZeroIsId: true); + case "Upgrade": + { + var attributes = FieldAsInt(row, 4); + return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + UpgradeCode = FieldAsString(row, 0), + VersionMin = FieldAsString(row, 1), + VersionMax = FieldAsString(row, 2), + Language = FieldAsString(row, 3), + Remove = FieldAsString(row, 5), + ActionProperty = FieldAsString(row, 6), + MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, + OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, + IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, + VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, + VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, + ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, + }; + } + case "Verb": + return DefaultSymbolFromRow(typeof(VerbSymbol), row, columnZeroIsId: false); + case "WixAction": + { + var sequenceTable = FieldAsString(row, 0); + return new WixActionSymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), + Action = FieldAsString(row, 1), + Condition = FieldAsString(row, 2), + Sequence = FieldAsNullableInt(row, 3), + Before = FieldAsString(row, 4), + After = FieldAsString(row, 5), + Overridable = FieldAsNullableInt(row, 6) != 0, + }; + } + case "WixBootstrapperApplication": + return DefaultSymbolFromRow(typeof(WixBootstrapperApplicationSymbol), row, columnZeroIsId: true); + case "WixBundleContainer": + return DefaultSymbolFromRow(typeof(WixBundleContainerSymbol), row, columnZeroIsId: true); + case "WixBundleVariable": + return DefaultSymbolFromRow(typeof(WixBundleVariableSymbol), row, columnZeroIsId: true); + case "WixChainItem": + return DefaultSymbolFromRow(typeof(WixChainItemSymbol), row, columnZeroIsId: true); + case "WixCustomTable": + return DefaultSymbolFromRow(typeof(WixCustomTableSymbol), row, columnZeroIsId: true); + case "WixDirectory": + return null; + case "WixFile": + return null; + case "WixInstanceTransforms": + return DefaultSymbolFromRow(typeof(WixInstanceTransformsSymbol), row, columnZeroIsId: true); + case "WixMedia": + return null; + case "WixMerge": + return DefaultSymbolFromRow(typeof(WixMergeSymbol), row, columnZeroIsId: true); + case "WixPatchBaseline": + return DefaultSymbolFromRow(typeof(WixPatchBaselineSymbol), row, columnZeroIsId: true); + case "WixProperty": + { + var attributes = FieldAsInt(row, 1); + return new WixPropertySymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + PropertyRef = FieldAsString(row, 0), + Admin = (attributes & 0x1) == 0x1, + Hidden = (attributes & 0x2) == 0x2, + Secure = (attributes & 0x4) == 0x4, + }; + } + case "WixSuppressModularization": + return DefaultSymbolFromRow(typeof(WixSuppressModularizationSymbol), row, columnZeroIsId: true); + case "WixUI": + return DefaultSymbolFromRow(typeof(WixUISymbol), row, columnZeroIsId: true); + case "WixVariable": + return DefaultSymbolFromRow(typeof(WixVariableSymbol), row, columnZeroIsId: true); + default: + return GenericSymbolFromCustomRow(row, columnZeroIsId: false); + } + } + + private static CustomActionTargetType DetermineCustomActionTargetType(int type) + { + var targetType = default(CustomActionTargetType); + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) + { + targetType = CustomActionTargetType.VBScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) + { + targetType = CustomActionTargetType.JScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) + { + targetType = CustomActionTargetType.TextData; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) + { + targetType = CustomActionTargetType.Exe; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) + { + targetType = CustomActionTargetType.Dll; + } + + return targetType; + } + + private static CustomActionSourceType DetermineCustomActionSourceType(int type) + { + var sourceType = CustomActionSourceType.Binary; + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) + { + sourceType = CustomActionSourceType.Property; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) + { + sourceType = CustomActionSourceType.Directory; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) + { + sourceType = CustomActionSourceType.File; + } + + return sourceType; + } + + private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) + { + var executionType = CustomActionExecutionType.Immediate; + + if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) + { + executionType = CustomActionExecutionType.Commit; + } + else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) + { + executionType = CustomActionExecutionType.Rollback; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) + { + executionType = CustomActionExecutionType.Deferred; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) + { + executionType = CustomActionExecutionType.ClientRepeat; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) + { + executionType = CustomActionExecutionType.OncePerProcess; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) + { + executionType = CustomActionExecutionType.FirstSequence; + } + + return executionType; + } + + private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) + { + switch (columnType) + { + case Wix3.ColumnType.Number: + return IntermediateFieldType.Number; + case Wix3.ColumnType.Object: + return IntermediateFieldType.Path; + case Wix3.ColumnType.Unknown: + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Preserved: + default: + return IntermediateFieldType.String; + } + } + + private static IntermediateSymbol DefaultSymbolFromRow(Type symbolType, Wix3.Row row, bool columnZeroIsId) + { + var symbol = Activator.CreateInstance(symbolType) as IntermediateSymbol; + + SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); + + symbol.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); + return symbol; + } + + private static IntermediateSymbol GenericSymbolFromCustomRow(Wix3.Row row, bool columnZeroIsId) + { + var columnDefinitions = row.Table.Definition.Columns.Cast(); + var fieldDefinitions = columnDefinitions.Select(columnDefinition => + new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); + var symbolDefinition = new IntermediateSymbolDefinition(row.Table.Name, fieldDefinitions, null); + var symbol = new IntermediateSymbol(symbolDefinition, SourceLineNumber4(row.SourceLineNumbers)); + + SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); + + return symbol; + } + + private static void SetSymbolFieldsFromRow(Wix3.Row row, IntermediateSymbol symbol, bool columnZeroIsId) + { + int offset = 0; + if (columnZeroIsId) + { + symbol.Id = GetIdentifierForRow(row); + offset = 1; + } + + for (var i = offset; i < row.Fields.Length; ++i) + { + var column = row.Fields[i].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + symbol.Set(i - offset, FieldAsString(row, i)); + break; + case Wix3.ColumnType.Number: + int? nullableValue = FieldAsNullableInt(row, i); + // TODO: Consider whether null values should be coerced to their default value when + // a column is not nullable. For now, just pass through the null. + //int value = FieldAsInt(row, i); + //symbol.Set(i - offset, column.IsNullable ? nullableValue : value); + symbol.Set(i - offset, nullableValue); + break; + case Wix3.ColumnType.Unknown: + break; + } + } + } + + private static Identifier GetIdentifierForRow(Wix3.Row row) + { + var column = row.Fields[0].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); + case Wix3.ColumnType.Number: + return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); + default: + return null; + } + } + + private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) + { + switch (outputType) + { + case Wix3.OutputType.Bundle: + return SectionType.Bundle; + case Wix3.OutputType.Module: + return SectionType.Module; + case Wix3.OutputType.Patch: + return SectionType.Patch; + case Wix3.OutputType.PatchCreation: + return SectionType.PatchCreation; + case Wix3.OutputType.Product: + return SectionType.Product; + case Wix3.OutputType.Transform: + case Wix3.OutputType.Unknown: + default: + return SectionType.Unknown; + } + } + + private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) + { + return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); + } + + private static string FieldAsString(Wix3.Row row, int column) + { + return (string)row[column]; + } + + private static int FieldAsInt(Wix3.Row row, int column) + { + return Convert.ToInt32(row[column]); + } + + private static int? FieldAsNullableInt(Wix3.Row row, int column) + { + var field = row.Fields[column]; + if (field.Data == null) + { + return null; + } + else + { + return Convert.ToInt32(field.Data); + } + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : null, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : null + }; + } + } +} diff --git a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj new file mode 100644 index 00000000..4aad6d07 --- /dev/null +++ b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj @@ -0,0 +1,34 @@ + + + + + + + netstandard2.0;net461;net472 + Symbolizer + WiX Toolset Converters Tuplizer + embedded + true + + + + NU1701 + + + + + + + + + + + + + + + + + + + diff --git a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs b/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs deleted file mode 100644 index a53c3a74..00000000 --- a/src/WixToolset.Converters.Tupleizer/ConvertTuples.cs +++ /dev/null @@ -1,814 +0,0 @@ -// 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.Converters.Tupleizer -{ - using System; - using System.Collections.Generic; - using System.Linq; - using WixToolset.Data; - using WixToolset.Data.Tuples; - using WixToolset.Data.WindowsInstaller; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - - public static class ConvertTuples - { - public static Intermediate ConvertFile(string path) - { - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - return ConvertOutput(output); - } - - public static Intermediate ConvertOutput(Wix3.Output output) - { - var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); - - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - var componentsById = IndexById(output, "Component"); - var bindPathsById = IndexById(output, "BindPath"); - var fontsById = IndexById(output, "Font"); - var selfRegById = IndexById(output, "SelfReg"); - var wixDirectoryById = IndexById(output, "WixDirectory"); - var wixFileById = IndexById(output, "WixFile"); - - foreach (Wix3.Table table in output.Tables) - { - foreach (Wix3.Row row in table.Rows) - { - var tuple = GenerateTupleFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); - if (tuple != null) - { - section.Tuples.Add(tuple); - } - } - } - - return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add(FieldAsInt(row, 0), row); - } - } - - return wixMediaByDiskId; - } - - private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row - { - var byId = new Dictionary(); - var table = output.Tables[tableName]; - - if (table != null) - { - foreach (T row in table.Rows) - { - byId.Add(FieldAsString(row, 0), row); - } - } - - return byId; - } - - private static IntermediateTuple GenerateTupleFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) - { - var name = row.Table.Name; - switch (name) - { - case "_SummaryInformation": - return DefaultTupleFromRow(typeof(SummaryInformationTuple), row, columnZeroIsId: false); - case "ActionText": - return DefaultTupleFromRow(typeof(ActionTextTuple), row, columnZeroIsId: false); - case "AppId": - return DefaultTupleFromRow(typeof(AppIdTuple), row, columnZeroIsId: false); - case "AppSearch": - return DefaultTupleFromRow(typeof(AppSearchTuple), row, columnZeroIsId: false); - case "Billboard": - return DefaultTupleFromRow(typeof(BillboardTuple), row, columnZeroIsId: true); - case "Binary": - return DefaultTupleFromRow(typeof(BinaryTuple), row, columnZeroIsId: true); - case "BindPath": - return null; - case "CCPSearch": - return DefaultTupleFromRow(typeof(CCPSearchTuple), row, columnZeroIsId: true); - case "Class": - return DefaultTupleFromRow(typeof(ClassTuple), row, columnZeroIsId: false); - case "CompLocator": - return DefaultTupleFromRow(typeof(CompLocatorTuple), row, columnZeroIsId: false); - case "Component": - { - var attributes = FieldAsNullableInt(row, 3); - - var location = ComponentLocation.LocalOnly; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) - { - location = ComponentLocation.SourceOnly; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) - { - location = ComponentLocation.Either; - } - - var keyPath = FieldAsString(row, 5); - var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) - { - keyPathType = ComponentKeyPathType.Registry; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) - { - keyPathType = ComponentKeyPathType.OdbcDataSource; - } - - return new ComponentTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentId = FieldAsString(row, 1), - DirectoryRef = FieldAsString(row, 2), - Condition = FieldAsString(row, 4), - KeyPath = keyPath, - Location = location, - DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, - NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, - Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, - SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, - Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, - Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, - UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, - Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, - KeyPathType = keyPathType, - }; - } - - case "Condition": - return DefaultTupleFromRow(typeof(ConditionTuple), row, columnZeroIsId: false); - case "CreateFolder": - return DefaultTupleFromRow(typeof(CreateFolderTuple), row, columnZeroIsId: false); - case "CustomAction": - { - var caType = FieldAsInt(row, 1); - var executionType = DetermineCustomActionExecutionType(caType); - var sourceType = DetermineCustomActionSourceType(caType); - var targetType = DetermineCustomActionTargetType(caType); - - return new CustomActionTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ExecutionType = executionType, - SourceType = sourceType, - Source = FieldAsString(row, 2), - TargetType = targetType, - Target = FieldAsString(row, 3), - Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, - TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, - Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, - IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, - Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, - Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, - }; - } - - case "Directory": - { - var id = FieldAsString(row, 0); - var splits = SplitDefaultDir(FieldAsString(row, 2)); - - var tuple = new DirectoryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) - { - ParentDirectoryRef = FieldAsString(row, 1), - Name = splits[0], - ShortName = splits[1], - SourceName = splits[2], - SourceShortName = splits[3] - }; - - if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) - { - tuple.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); - } - - return tuple; - } - case "DrLocator": - return DefaultTupleFromRow(typeof(DrLocatorTuple), row, columnZeroIsId: false); - case "DuplicateFile": - return DefaultTupleFromRow(typeof(DuplicateFileTuple), row, columnZeroIsId: true); - case "Error": - return DefaultTupleFromRow(typeof(ErrorTuple), row, columnZeroIsId: false); - case "Extension": - return DefaultTupleFromRow(typeof(ExtensionTuple), row, columnZeroIsId: false); - case "Feature": - { - var attributes = FieldAsInt(row, 7); - var installDefault = FeatureInstallDefault.Local; - if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) - { - installDefault = FeatureInstallDefault.FollowParent; - } - else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) - { - installDefault = FeatureInstallDefault.Source; - } - - return new FeatureTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ParentFeatureRef = FieldAsString(row, 1), - Title = FieldAsString(row, 2), - Description = FieldAsString(row, 3), - Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), - Level = FieldAsInt(row, 5), - DirectoryRef = FieldAsString(row, 6), - DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, - DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, - InstallDefault = installDefault, - TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, - }; - } - - case "FeatureComponents": - return DefaultTupleFromRow(typeof(FeatureComponentsTuple), row, columnZeroIsId: false); - case "File": - { - var attributes = FieldAsNullableInt(row, 6); - - FileTupleAttributes tupleAttributes = 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileTupleAttributes.ReadOnly : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileTupleAttributes.Hidden : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileTupleAttributes.System : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileTupleAttributes.Vital : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileTupleAttributes.Checksum : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileTupleAttributes.Uncompressed : 0; - tupleAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileTupleAttributes.Compressed : 0; - - var id = FieldAsString(row, 0); - - var tuple = new FileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) - { - ComponentRef = FieldAsString(row, 1), - Name = FieldAsString(row, 2), - FileSize = FieldAsInt(row, 3), - Version = FieldAsString(row, 4), - Language = FieldAsString(row, 5), - Attributes = tupleAttributes - }; - - if (bindPathsById.TryGetValue(id, out var bindPathRow)) - { - tuple.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; - } - - if (fontsById.TryGetValue(id, out var fontRow)) - { - tuple.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; - } - - if (selfRegById.TryGetValue(id, out var selfRegRow)) - { - tuple.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; - } - - if (wixFileById.TryGetValue(id, out var wixFileRow)) - { - tuple.DirectoryRef = FieldAsString(wixFileRow, 4); - tuple.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; - tuple.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; - tuple.PatchGroup = FieldAsInt(wixFileRow, 8); - tuple.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileTupleAttributes.GeneratedShortFileName : 0; - tuple.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); - } - - return tuple; - } - case "Font": - return null; - case "Icon": - return DefaultTupleFromRow(typeof(IconTuple), row, columnZeroIsId: true); - case "IniLocator": - return DefaultTupleFromRow(typeof(IniLocatorTuple), row, columnZeroIsId: false); - case "LockPermissions": - return DefaultTupleFromRow(typeof(LockPermissionsTuple), row, columnZeroIsId: false); - case "Media": - { - var diskId = FieldAsInt(row, 0); - var tuple = new MediaTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) - { - DiskId = diskId, - LastSequence = FieldAsNullableInt(row, 1), - DiskPrompt = FieldAsString(row, 2), - Cabinet = FieldAsString(row, 3), - VolumeLabel = FieldAsString(row, 4), - Source = FieldAsString(row, 5) - }; - - if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) - { - var compressionLevel = FieldAsString(wixMediaRow, 1); - - tuple.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); - tuple.Layout = wixMediaRow.Layout; - } - - return tuple; - } - case "MIME": - return DefaultTupleFromRow(typeof(MIMETuple), row, columnZeroIsId: false); - case "ModuleIgnoreTable": - return DefaultTupleFromRow(typeof(ModuleIgnoreTableTuple), row, columnZeroIsId: true); - case "MoveFile": - return DefaultTupleFromRow(typeof(MoveFileTuple), row, columnZeroIsId: true); - case "MsiAssembly": - { - var componentId = FieldAsString(row, 0); - if (componentsById.TryGetValue(componentId, out var componentRow)) - { - return new AssemblyTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) - { - ComponentRef = componentId, - FeatureRef = FieldAsString(row, 1), - ManifestFileRef = FieldAsString(row, 2), - ApplicationFileRef = FieldAsString(row, 3), - Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, - }; - } - - return null; - } - case "MsiLockPermissionsEx": - return DefaultTupleFromRow(typeof(MsiLockPermissionsExTuple), row, columnZeroIsId: true); - case "MsiShortcutProperty": - return DefaultTupleFromRow(typeof(MsiShortcutPropertyTuple), row, columnZeroIsId: true); - case "ODBCDataSource": - return DefaultTupleFromRow(typeof(ODBCDataSourceTuple), row, columnZeroIsId: true); - case "ODBCDriver": - return DefaultTupleFromRow(typeof(ODBCDriverTuple), row, columnZeroIsId: true); - case "ODBCTranslator": - return DefaultTupleFromRow(typeof(ODBCTranslatorTuple), row, columnZeroIsId: true); - case "ProgId": - return DefaultTupleFromRow(typeof(ProgIdTuple), row, columnZeroIsId: false); - case "Property": - return DefaultTupleFromRow(typeof(PropertyTuple), row, columnZeroIsId: true); - case "PublishComponent": - return DefaultTupleFromRow(typeof(PublishComponentTuple), row, columnZeroIsId: false); - case "Registry": - { - var value = FieldAsString(row, 4); - var valueType = RegistryValueType.String; - var valueAction = RegistryValueActionType.Write; - - if (!String.IsNullOrEmpty(value)) - { - if (value.StartsWith("#x", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Binary; - value = value.Substring(2); - } - else if (value.StartsWith("#%", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Expandable; - value = value.Substring(2); - } - else if (value.StartsWith("#", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Integer; - value = value.Substring(1); - } - else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3, value.Length - 6); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Write; - } - else if (value.StartsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Append; - } - else if (value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(0, value.Length - 3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Prepend; - } - } - - return new RegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Value = value, - ComponentRef = FieldAsString(row, 5), - ValueAction = valueAction, - ValueType = valueType, - }; - } - case "RegLocator": - { - var type = FieldAsInt(row, 4); - - return new RegLocatorTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Type = (RegLocatorType)(type & 0xF), - Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit - }; - } - case "RemoveFile": - { - var installMode = FieldAsInt(row, 4); - return new RemoveFileTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentRef = FieldAsString(row, 1), - FileName = FieldAsString(row, 2), - DirProperty = FieldAsString(row, 3), - OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, - OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null - }; - } - case "RemoveRegistry": - { - return new RemoveRegistryTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Action = RemoveRegistryActionType.RemoveOnInstall, - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - ComponentRef = FieldAsString(row, 4), - }; - } - - case "ReserveCost": - return DefaultTupleFromRow(typeof(ReserveCostTuple), row, columnZeroIsId: true); - case "SelfReg": - return null; - case "ServiceControl": - { - var events = FieldAsInt(row, 2); - var wait = FieldAsNullableInt(row, 4); - return new ServiceControlTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Name = FieldAsString(row, 1), - Arguments = FieldAsString(row, 3), - Wait = !wait.HasValue || wait.Value == 1, - ComponentRef = FieldAsString(row, 5), - InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, - UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, - InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, - UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, - InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, - UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, - }; - } - - case "ServiceInstall": - return DefaultTupleFromRow(typeof(ServiceInstallTuple), row, columnZeroIsId: true); - case "Shortcut": - { - var splitName = FieldAsString(row, 2).Split('|'); - - return new ShortcutTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - DirectoryRef = FieldAsString(row, 1), - Name = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortName = splitName.Length > 1 ? splitName[0] : null, - ComponentRef = FieldAsString(row, 3), - Target = FieldAsString(row, 4), - Arguments = FieldAsString(row, 5), - Description = FieldAsString(row, 6), - Hotkey = FieldAsNullableInt(row, 7), - IconRef = FieldAsString(row, 8), - IconIndex = FieldAsNullableInt(row, 9), - Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), - WorkingDirectory = FieldAsString(row, 11), - DisplayResourceDll = FieldAsString(row, 12), - DisplayResourceId = FieldAsNullableInt(row, 13), - DescriptionResourceDll = FieldAsString(row, 14), - DescriptionResourceId= FieldAsNullableInt(row, 15), - }; - } - case "Signature": - return DefaultTupleFromRow(typeof(SignatureTuple), row, columnZeroIsId: true); - case "UIText": - return DefaultTupleFromRow(typeof(UITextTuple), row, columnZeroIsId: true); - case "Upgrade": - { - var attributes = FieldAsInt(row, 4); - return new UpgradeTuple(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - UpgradeCode = FieldAsString(row, 0), - VersionMin = FieldAsString(row, 1), - VersionMax = FieldAsString(row, 2), - Language = FieldAsString(row, 3), - Remove = FieldAsString(row, 5), - ActionProperty = FieldAsString(row, 6), - MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, - OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, - IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, - VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, - VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, - ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, - }; - } - case "Verb": - return DefaultTupleFromRow(typeof(VerbTuple), row, columnZeroIsId: false); - case "WixAction": - { - var sequenceTable = FieldAsString(row, 0); - return new WixActionTuple(SourceLineNumber4(row.SourceLineNumbers)) - { - SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), - Action = FieldAsString(row, 1), - Condition = FieldAsString(row, 2), - Sequence = FieldAsNullableInt(row, 3), - Before = FieldAsString(row, 4), - After = FieldAsString(row, 5), - Overridable = FieldAsNullableInt(row, 6) != 0, - }; - } - case "WixBootstrapperApplication": - return DefaultTupleFromRow(typeof(WixBootstrapperApplicationTuple), row, columnZeroIsId: true); - case "WixBundleContainer": - return DefaultTupleFromRow(typeof(WixBundleContainerTuple), row, columnZeroIsId: true); - case "WixBundleVariable": - return DefaultTupleFromRow(typeof(WixBundleVariableTuple), row, columnZeroIsId: true); - case "WixChainItem": - return DefaultTupleFromRow(typeof(WixChainItemTuple), row, columnZeroIsId: true); - case "WixCustomTable": - return DefaultTupleFromRow(typeof(WixCustomTableTuple), row, columnZeroIsId: true); - case "WixDirectory": - return null; - case "WixFile": - return null; - case "WixInstanceTransforms": - return DefaultTupleFromRow(typeof(WixInstanceTransformsTuple), row, columnZeroIsId: true); - case "WixMedia": - return null; - case "WixMerge": - return DefaultTupleFromRow(typeof(WixMergeTuple), row, columnZeroIsId: true); - case "WixPatchBaseline": - return DefaultTupleFromRow(typeof(WixPatchBaselineTuple), row, columnZeroIsId: true); - case "WixProperty": - { - var attributes = FieldAsInt(row, 1); - return new WixPropertyTuple(SourceLineNumber4(row.SourceLineNumbers)) - { - PropertyRef = FieldAsString(row, 0), - Admin = (attributes & 0x1) == 0x1, - Hidden = (attributes & 0x2) == 0x2, - Secure = (attributes & 0x4) == 0x4, - }; - } - case "WixSuppressModularization": - return DefaultTupleFromRow(typeof(WixSuppressModularizationTuple), row, columnZeroIsId: true); - case "WixUI": - return DefaultTupleFromRow(typeof(WixUITuple), row, columnZeroIsId: true); - case "WixVariable": - return DefaultTupleFromRow(typeof(WixVariableTuple), row, columnZeroIsId: true); - default: - return GenericTupleFromCustomRow(row, columnZeroIsId: false); - } - } - - private static CustomActionTargetType DetermineCustomActionTargetType(int type) - { - var targetType = default(CustomActionTargetType); - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) - { - targetType = CustomActionTargetType.VBScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) - { - targetType = CustomActionTargetType.JScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) - { - targetType = CustomActionTargetType.TextData; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) - { - targetType = CustomActionTargetType.Exe; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) - { - targetType = CustomActionTargetType.Dll; - } - - return targetType; - } - - private static CustomActionSourceType DetermineCustomActionSourceType(int type) - { - var sourceType = CustomActionSourceType.Binary; - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) - { - sourceType = CustomActionSourceType.Property; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) - { - sourceType = CustomActionSourceType.Directory; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) - { - sourceType = CustomActionSourceType.File; - } - - return sourceType; - } - - private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) - { - var executionType = CustomActionExecutionType.Immediate; - - if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) - { - executionType = CustomActionExecutionType.Commit; - } - else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) - { - executionType = CustomActionExecutionType.Rollback; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) - { - executionType = CustomActionExecutionType.Deferred; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) - { - executionType = CustomActionExecutionType.ClientRepeat; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) - { - executionType = CustomActionExecutionType.OncePerProcess; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) - { - executionType = CustomActionExecutionType.FirstSequence; - } - - return executionType; - } - - private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) - { - switch (columnType) - { - case Wix3.ColumnType.Number: - return IntermediateFieldType.Number; - case Wix3.ColumnType.Object: - return IntermediateFieldType.Path; - case Wix3.ColumnType.Unknown: - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Preserved: - default: - return IntermediateFieldType.String; - } - } - - private static IntermediateTuple DefaultTupleFromRow(Type tupleType, Wix3.Row row, bool columnZeroIsId) - { - var tuple = Activator.CreateInstance(tupleType) as IntermediateTuple; - - SetTupleFieldsFromRow(row, tuple, columnZeroIsId); - - tuple.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); - return tuple; - } - - private static IntermediateTuple GenericTupleFromCustomRow(Wix3.Row row, bool columnZeroIsId) - { - var columnDefinitions = row.Table.Definition.Columns.Cast(); - var fieldDefinitions = columnDefinitions.Select(columnDefinition => - new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); - var tupleDefinition = new IntermediateTupleDefinition(row.Table.Name, fieldDefinitions, null); - var tuple = new IntermediateTuple(tupleDefinition, SourceLineNumber4(row.SourceLineNumbers)); - - SetTupleFieldsFromRow(row, tuple, columnZeroIsId); - - return tuple; - } - - private static void SetTupleFieldsFromRow(Wix3.Row row, IntermediateTuple tuple, bool columnZeroIsId) - { - int offset = 0; - if (columnZeroIsId) - { - tuple.Id = GetIdentifierForRow(row); - offset = 1; - } - - for (var i = offset; i < row.Fields.Length; ++i) - { - var column = row.Fields[i].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - tuple.Set(i - offset, FieldAsString(row, i)); - break; - case Wix3.ColumnType.Number: - int? nullableValue = FieldAsNullableInt(row, i); - // TODO: Consider whether null values should be coerced to their default value when - // a column is not nullable. For now, just pass through the null. - //int value = FieldAsInt(row, i); - //tuple.Set(i - offset, column.IsNullable ? nullableValue : value); - tuple.Set(i - offset, nullableValue); - break; - case Wix3.ColumnType.Unknown: - break; - } - } - } - - private static Identifier GetIdentifierForRow(Wix3.Row row) - { - var column = row.Fields[0].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); - case Wix3.ColumnType.Number: - return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); - default: - return null; - } - } - - private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) - { - switch (outputType) - { - case Wix3.OutputType.Bundle: - return SectionType.Bundle; - case Wix3.OutputType.Module: - return SectionType.Module; - case Wix3.OutputType.Patch: - return SectionType.Patch; - case Wix3.OutputType.PatchCreation: - return SectionType.PatchCreation; - case Wix3.OutputType.Product: - return SectionType.Product; - case Wix3.OutputType.Transform: - case Wix3.OutputType.Unknown: - default: - return SectionType.Unknown; - } - } - - private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) - { - return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); - } - - private static string FieldAsString(Wix3.Row row, int column) - { - return (string)row[column]; - } - - private static int FieldAsInt(Wix3.Row row, int column) - { - return Convert.ToInt32(row[column]); - } - - private static int? FieldAsNullableInt(Wix3.Row row, int column) - { - var field = row.Fields[column]; - if (field.Data == null) - { - return null; - } - else - { - return Convert.ToInt32(field.Data); - } - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : null, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : null - }; - } - } -} diff --git a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj b/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj deleted file mode 100644 index cafb5feb..00000000 --- a/src/WixToolset.Converters.Tupleizer/WixToolset.Converters.Tupleizer.csproj +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - netstandard2.0;net461;net472 - Tupleizer - WiX Toolset Converters Tuplizer - embedded - true - - - - NU1701 - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs new file mode 100644 index 00000000..ae054079 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs @@ -0,0 +1,606 @@ +// 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 WixToolsetTest.Converters.Symbolizer +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Linq; + using WixBuildTools.TestSupport; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + using WixToolset.Converters.Symbolizer; + using WixToolset.Data; + using WixToolset.Data.WindowsInstaller; + using WixToolset.Data.Symbols; + using Xunit; + + public class ConvertSymbolsFixture + { + [Fact] + public void CanLoadWixoutAndConvertToIntermediate() + { + var rootFolder = TestData.Get(); + var dataFolder = TestData.Get(@"TestData\Integration"); + + using (var fs = new DisposableFileSystem()) + { + var intermediateFolder = fs.GetFolder(); + + var path = Path.Combine(dataFolder, "test.wixout"); + + var intermediate = ConvertSymbols.ConvertFile(path); + + Assert.NotNull(intermediate); + Assert.Single(intermediate.Sections); + Assert.Equal(String.Empty, intermediate.Id); + + // Save and load to guarantee round-tripping support. + // + var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); + intermediate.Save(wixiplFile); + + intermediate = Intermediate.Load(wixiplFile); + + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + + // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. + // + var tables = output.Tables.Cast(); + var wix3Dump = tables + .SelectMany(table => table.Rows.Cast() + .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) + .Where(s => !String.IsNullOrEmpty(s)) + .OrderBy(s => s) + .ToArray(); + + var symbols = intermediate.Sections.SelectMany(s => s.Symbols); + + var assemblySymbolsByFileId = symbols.OfType().ToDictionary(a => a.Id.Id); + + var wix4Dump = symbols + .SelectMany(symbol => SymbolToStrings(symbol, assemblySymbolsByFileId)) + .OrderBy(s => s) + .ToArray(); + +#if false + Assert.Equal(wix3Dump, wix4Dump); +#else // useful when you want to diff the outputs with another diff tool. + var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); + var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); + + var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); + var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); + + File.WriteAllText(path3, wix3TextDump); + File.WriteAllText(path4, wix4TextDump); + + Assert.Equal(wix3TextDump, wix4TextDump); +#endif + } + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add((int)row[0], row); + } + } + + return wixMediaByDiskId; + } + + private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) + { + string fields = null; + + // Massage output to match WiX v3 rows and v4 symbols. + // + switch (row.Table.Name) + { + case "Directory": + var dirs = SplitDefaultDir((string)row[2]); + fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); + break; + case "File": + { + var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); + if (fieldValues[3] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[3] = "0"; + } + fields = String.Join(",", fieldValues); + break; + } + case "Media": + var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; + + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); + break; + case "RegLocator": + var type = (int)row[4]; + fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); + break; + case "RemoveFile": + var attributes = (int)row[4]; + var onInstall = (attributes & 1) == 1 ? (bool?)true : null; + var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; + fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); + fields = String.Join(",", fields, onInstall, onUninstall); + break; + case "Shortcut": + var split = ((string)row[2]).Split('|'); + var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); + fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); + break; + case "WixAction": + var table = (int)SequenceStringToSequenceTable(row[0]); + fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); + break; + case "WixFile": + { + var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); + if (fieldValues[8] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[8] = "0"; + } + if (fieldValues[10] == null) + { + // WixFile rows that come from merge modules will not have the attributes column set + // so initilaize with 0. + fieldValues[10] = "0"; + } + fields = String.Join(",", fieldValues); + break; + } + case "WixMedia": + break; + default: + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + break; + } + + if (fields != null) + { + yield return $"{row.Table.Name}:{fields}"; + } + } + + private static IEnumerable SymbolToStrings(IntermediateSymbol symbol, Dictionary assemblySymbolsByFileId) + { + var name = symbol.Definition.Type == SymbolDefinitionType.SummaryInformation ? "_SummaryInformation" : symbol.Definition.Name; + var id = symbol.Id?.Id ?? String.Empty; + + string fields; + switch (symbol.Definition.Name) + { + // Massage output to match WiX v3 rows and v4 symbols. + // + case "Component": + { + var componentSymbol = (ComponentSymbol)symbol; + var attributes = ComponentLocation.Either == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; + attributes |= ComponentLocation.SourceOnly == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; + attributes |= ComponentKeyPathType.Registry == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; + attributes |= ComponentKeyPathType.OdbcDataSource == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; + attributes |= componentSymbol.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; + attributes |= componentSymbol.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; + attributes |= componentSymbol.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; + attributes |= componentSymbol.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; + attributes |= componentSymbol.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; + attributes |= componentSymbol.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; + attributes |= componentSymbol.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + attributes |= componentSymbol.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + + fields = String.Join(",", + componentSymbol.ComponentId, + componentSymbol.DirectoryRef, + attributes.ToString(), + componentSymbol.Condition, + componentSymbol.KeyPath + ); + break; + } + case "CustomAction": + { + var customActionSymbol = (CustomActionSymbol)symbol; + var type = customActionSymbol.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; + type |= customActionSymbol.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; + type |= customActionSymbol.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; + type |= customActionSymbol.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; + type |= customActionSymbol.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; + type |= customActionSymbol.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; + type |= CustomActionExecutionType.FirstSequence == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; + type |= CustomActionExecutionType.OncePerProcess == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; + type |= CustomActionExecutionType.ClientRepeat == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; + type |= CustomActionExecutionType.Deferred == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; + type |= CustomActionExecutionType.Rollback == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; + type |= CustomActionExecutionType.Commit == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; + type |= CustomActionSourceType.File == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; + type |= CustomActionSourceType.Directory == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; + type |= CustomActionSourceType.Property == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; + type |= CustomActionTargetType.Dll == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; + type |= CustomActionTargetType.Exe == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; + type |= CustomActionTargetType.TextData == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; + type |= CustomActionTargetType.JScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; + type |= CustomActionTargetType.VBScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; + + fields = String.Join(",", + type.ToString(), + customActionSymbol.Source, + customActionSymbol.Target, + customActionSymbol.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null + ); + break; + } + case "Directory": + { + var directorySymbol = (DirectorySymbol)symbol; + + if (!String.IsNullOrEmpty(directorySymbol.ComponentGuidGenerationSeed)) + { + yield return $"WixDirectory:{directorySymbol.Id.Id},{directorySymbol.ComponentGuidGenerationSeed}"; + } + + fields = String.Join(",", directorySymbol.ParentDirectoryRef, directorySymbol.Name, directorySymbol.ShortName, directorySymbol.SourceName, directorySymbol.SourceShortName); + break; + } + case "Feature": + { + var featureSymbol = (FeatureSymbol)symbol; + var attributes = featureSymbol.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; + attributes |= featureSymbol.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; + attributes |= FeatureInstallDefault.FollowParent == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; + attributes |= FeatureInstallDefault.Source == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; + attributes |= FeatureTypicalDefault.Advertise == featureSymbol.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; + + fields = String.Join(",", + featureSymbol.ParentFeatureRef, + featureSymbol.Title, + featureSymbol.Description, + featureSymbol.Display.ToString(), + featureSymbol.Level.ToString(), + featureSymbol.DirectoryRef, + attributes.ToString()); + break; + } + case "File": + { + var fileSymbol = (FileSymbol)symbol; + + if (fileSymbol.BindPath != null) + { + yield return $"BindImage:{fileSymbol.Id.Id},{fileSymbol.BindPath}"; + } + + if (fileSymbol.FontTitle != null) + { + yield return $"Font:{fileSymbol.Id.Id},{fileSymbol.FontTitle}"; + } + + if (fileSymbol.SelfRegCost.HasValue) + { + yield return $"SelfReg:{fileSymbol.Id.Id},{fileSymbol.SelfRegCost}"; + } + + int? assemblyAttributes = null; + if (assemblySymbolsByFileId.TryGetValue(fileSymbol.Id.Id, out var assemblySymbol)) + { + if (assemblySymbol.Type == AssemblyType.DotNetAssembly) + { + assemblyAttributes = 0; + } + else if (assemblySymbol.Type == AssemblyType.Win32Assembly) + { + assemblyAttributes = 1; + } + } + + yield return "WixFile:" + String.Join(",", + fileSymbol.Id.Id, + assemblyAttributes, + assemblySymbol?.ManifestFileRef, + assemblySymbol?.ApplicationFileRef, + fileSymbol.DirectoryRef, + fileSymbol.DiskId, + fileSymbol.Source.Path, + null, // assembly processor arch + fileSymbol.PatchGroup, + (fileSymbol.Attributes & FileSymbolAttributes.GeneratedShortFileName) != 0 ? 1 : 0, + (int)fileSymbol.PatchAttributes, + fileSymbol.RetainLengths, + fileSymbol.IgnoreOffsets, + fileSymbol.IgnoreLengths, + fileSymbol.RetainOffsets + ); + + var fileAttributes = 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; + + fields = String.Join(",", + fileSymbol.ComponentRef, + fileSymbol.Name, + fileSymbol.FileSize.ToString(), + fileSymbol.Version, + fileSymbol.Language, + fileAttributes); + break; + } + + case "Media": + fields = String.Join(",", symbol.Fields.Skip(1).Select(SafeConvertField)); + break; + + case "Assembly": + { + var assemblySymbol = (AssemblySymbol)symbol; + + id = null; + name = "MsiAssembly"; + fields = String.Join(",", assemblySymbol.ComponentRef, assemblySymbol.FeatureRef, assemblySymbol.ManifestFileRef, assemblySymbol.ApplicationFileRef, assemblySymbol.Type == AssemblyType.Win32Assembly ? 1 : 0); + break; + } + case "RegLocator": + { + var locatorSymbol = (RegLocatorSymbol)symbol; + + fields = String.Join(",", (int)locatorSymbol.Root, locatorSymbol.Key, locatorSymbol.Name, (int)locatorSymbol.Type, locatorSymbol.Win64); + break; + } + case "Registry": + { + var registrySymbol = (RegistrySymbol)symbol; + var value = registrySymbol.Value; + + switch (registrySymbol.ValueType) + { + case RegistryValueType.Binary: + value = String.Concat("#x", value); + break; + case RegistryValueType.Expandable: + value = String.Concat("#%", value); + break; + case RegistryValueType.Integer: + value = String.Concat("#", value); + break; + case RegistryValueType.MultiString: + switch (registrySymbol.ValueAction) + { + case RegistryValueActionType.Append: + value = String.Concat("[~]", value); + break; + case RegistryValueActionType.Prepend: + value = String.Concat(value, "[~]"); + break; + case RegistryValueActionType.Write: + default: + if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) + { + value = String.Concat("[~]", value, "[~]"); + } + break; + } + break; + case RegistryValueType.String: + // escape the leading '#' character for string registry keys + if (null != value && value.StartsWith("#", StringComparison.Ordinal)) + { + value = String.Concat("#", value); + } + break; + } + + fields = String.Join(",", + ((int)registrySymbol.Root).ToString(), + registrySymbol.Key, + registrySymbol.Name, + value, + registrySymbol.ComponentRef + ); + break; + } + + case "RemoveRegistry": + { + var removeRegistrySymbol = (RemoveRegistrySymbol)symbol; + fields = String.Join(",", + ((int)removeRegistrySymbol.Root).ToString(), + removeRegistrySymbol.Key, + removeRegistrySymbol.Name, + removeRegistrySymbol.ComponentRef + ); + break; + } + + case "ServiceControl": + { + var serviceControlSymbol = (ServiceControlSymbol)symbol; + + var events = serviceControlSymbol.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; + events |= serviceControlSymbol.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; + events |= serviceControlSymbol.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; + events |= serviceControlSymbol.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; + events |= serviceControlSymbol.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; + events |= serviceControlSymbol.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; + + fields = String.Join(",", + serviceControlSymbol.Name, + events.ToString(), + serviceControlSymbol.Arguments, + serviceControlSymbol.Wait == true ? "1" : "0", + serviceControlSymbol.ComponentRef + ); + break; + } + + case "ServiceInstall": + { + var serviceInstallSymbol = (ServiceInstallSymbol)symbol; + + var errorControl = (int)serviceInstallSymbol.ErrorControl; + errorControl |= serviceInstallSymbol.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; + + var serviceType = (int)serviceInstallSymbol.ServiceType; + serviceType |= serviceInstallSymbol.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; + + fields = String.Join(",", + serviceInstallSymbol.Name, + serviceInstallSymbol.DisplayName, + serviceType.ToString(), + ((int)serviceInstallSymbol.StartType).ToString(), + errorControl.ToString(), + serviceInstallSymbol.LoadOrderGroup, + serviceInstallSymbol.Dependencies, + serviceInstallSymbol.StartName, + serviceInstallSymbol.Password, + serviceInstallSymbol.Arguments, + serviceInstallSymbol.ComponentRef, + serviceInstallSymbol.Description + ); + break; + } + + case "Upgrade": + { + var upgradeSymbol = (UpgradeSymbol)symbol; + + var attributes = upgradeSymbol.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; + attributes |= upgradeSymbol.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; + attributes |= upgradeSymbol.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; + attributes |= upgradeSymbol.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; + attributes |= upgradeSymbol.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; + attributes |= upgradeSymbol.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; + + fields = String.Join(",", + upgradeSymbol.VersionMin, + upgradeSymbol.VersionMax, + upgradeSymbol.Language, + attributes.ToString(), + upgradeSymbol.Remove, + upgradeSymbol.ActionProperty + ); + break; + } + + case "WixAction": + { + var wixActionSymbol = (WixActionSymbol)symbol; + var data = wixActionSymbol.Fields[(int)WixActionSymbolFields.SequenceTable].AsObject(); + var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionSymbol.SequenceTable; + + fields = String.Join(",", + sequenceTableAsInt, + wixActionSymbol.Action, + wixActionSymbol.Condition, + wixActionSymbol.Sequence?.ToString() ?? String.Empty, + wixActionSymbol.Before, + wixActionSymbol.After, + wixActionSymbol.Overridable == true ? "1" : "0" + ); + break; + } + + case "WixComplexReference": + { + var wixComplexReferenceSymbol = (WixComplexReferenceSymbol)symbol; + fields = String.Join(",", + wixComplexReferenceSymbol.Parent, + (int)wixComplexReferenceSymbol.ParentType, + wixComplexReferenceSymbol.ParentLanguage, + wixComplexReferenceSymbol.Child, + (int)wixComplexReferenceSymbol.ChildType, + wixComplexReferenceSymbol.IsPrimary ? "1" : "0" + ); + break; + } + + case "WixProperty": + { + var wixPropertySymbol = (WixPropertySymbol)symbol; + var attributes = wixPropertySymbol.Admin ? 0x1 : 0; + attributes |= wixPropertySymbol.Hidden ? 0x2 : 0; + attributes |= wixPropertySymbol.Secure ? 0x4 : 0; + + fields = String.Join(",", + wixPropertySymbol.PropertyRef, + attributes.ToString() + ); + break; + } + + default: + fields = String.Join(",", symbol.Fields.Select(SafeConvertField)); + break; + } + + fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; + yield return $"{name}:{fields}"; + } + + private static SequenceTable SequenceStringToSequenceTable(object sequenceString) + { + switch (sequenceString) + { + case "AdminExecuteSequence": + return SequenceTable.AdminExecuteSequence; + case "AdminUISequence": + return SequenceTable.AdminUISequence; + case "AdvtExecuteSequence": + return SequenceTable.AdvertiseExecuteSequence; + case "InstallExecuteSequence": + return SequenceTable.InstallExecuteSequence; + case "InstallUISequence": + return SequenceTable.InstallUISequence; + default: + throw new ArgumentException($"Unknown sequence: {sequenceString}"); + } + } + + private static string SafeConvertField(Wix3.Field field) + { + return field?.Data?.ToString(); + } + + private static string SafeConvertField(IntermediateField field) + { + var data = field.AsObject(); + if (data is IntermediateFieldPathValue path) + { + return path.Path; + } + + return data?.ToString(); + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : String.Empty, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty + }; + } + } +} diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout new file mode 100644 index 00000000..da64b8af Binary files /dev/null and b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout differ diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj new file mode 100644 index 00000000..d7c4e625 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj @@ -0,0 +1,47 @@ + + + + Debug + x86 + 3.10 + d59f1c1e-9238-49fa-bfa2-ec1d9c2dda1d + 2.0 + SymbolizerWixout + Package + + + bin\$(Configuration)\ + obj\$(Configuration)\ + Debug + + + bin\$(Configuration)\ + obj\$(Configuration)\ + + + + + + + $(WixExtDir)\WixUtilExtension.dll + WixUtilExtension + + + $(WixExtDir)\WixNetFxExtension.dll + WixNetFxExtension + + + + + + + + + \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs new file mode 100644 index 00000000..46d4fb43 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj new file mode 100644 index 00000000..57ff1968 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj @@ -0,0 +1,33 @@ + + + + + + + net461 + false + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject new file mode 100644 index 00000000..18ab4f79 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject @@ -0,0 +1,9 @@ + + + + + WixToolsetTest.Converters.Symbolizer.ConvertSymbolsFixture.CanLoadWixoutAndConvertToIntermediate + + + + \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs deleted file mode 100644 index 5df577f6..00000000 --- a/src/test/WixToolsetTest.Converters.Tupleizer/ConvertTuplesFixture.cs +++ /dev/null @@ -1,606 +0,0 @@ -// 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 WixToolsetTest.Converters.Tupleizer -{ - using System; - using System.Collections.Generic; - using System.IO; - using System.Linq; - using WixBuildTools.TestSupport; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - using WixToolset.Converters.Tupleizer; - using WixToolset.Data; - using WixToolset.Data.WindowsInstaller; - using WixToolset.Data.Tuples; - using Xunit; - - public class ConvertTuplesFixture - { - [Fact] - public void CanLoadWixoutAndConvertToIntermediate() - { - var rootFolder = TestData.Get(); - var dataFolder = TestData.Get(@"TestData\Integration"); - - using (var fs = new DisposableFileSystem()) - { - var intermediateFolder = fs.GetFolder(); - - var path = Path.Combine(dataFolder, "test.wixout"); - - var intermediate = ConvertTuples.ConvertFile(path); - - Assert.NotNull(intermediate); - Assert.Single(intermediate.Sections); - Assert.Equal(String.Empty, intermediate.Id); - - // Save and load to guarantee round-tripping support. - // - var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); - intermediate.Save(wixiplFile); - - intermediate = Intermediate.Load(wixiplFile); - - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - - // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. - // - var tables = output.Tables.Cast(); - var wix3Dump = tables - .SelectMany(table => table.Rows.Cast() - .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) - .Where(s => !String.IsNullOrEmpty(s)) - .OrderBy(s => s) - .ToArray(); - - var tuples = intermediate.Sections.SelectMany(s => s.Tuples); - - var assemblyTuplesByFileId = tuples.OfType().ToDictionary(a => a.Id.Id); - - var wix4Dump = tuples - .SelectMany(tuple => TupleToStrings(tuple, assemblyTuplesByFileId)) - .OrderBy(s => s) - .ToArray(); - -#if false - Assert.Equal(wix3Dump, wix4Dump); -#else // useful when you want to diff the outputs with another diff tool. - var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); - var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); - - var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); - var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); - - File.WriteAllText(path3, wix3TextDump); - File.WriteAllText(path4, wix4TextDump); - - Assert.Equal(wix3TextDump, wix4TextDump); -#endif - } - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add((int)row[0], row); - } - } - - return wixMediaByDiskId; - } - - private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) - { - string fields = null; - - // Massage output to match WiX v3 rows and v4 tuples. - // - switch (row.Table.Name) - { - case "Directory": - var dirs = SplitDefaultDir((string)row[2]); - fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); - break; - case "File": - { - var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); - if (fieldValues[3] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[3] = "0"; - } - fields = String.Join(",", fieldValues); - break; - } - case "Media": - var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; - - fields = String.Join(",", row.Fields.Select(SafeConvertField)); - fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); - break; - case "RegLocator": - var type = (int)row[4]; - fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); - break; - case "RemoveFile": - var attributes = (int)row[4]; - var onInstall = (attributes & 1) == 1 ? (bool?)true : null; - var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; - fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); - fields = String.Join(",", fields, onInstall, onUninstall); - break; - case "Shortcut": - var split = ((string)row[2]).Split('|'); - var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); - fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); - break; - case "WixAction": - var table = (int)SequenceStringToSequenceTable(row[0]); - fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); - break; - case "WixFile": - { - var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); - if (fieldValues[8] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[8] = "0"; - } - if (fieldValues[10] == null) - { - // WixFile rows that come from merge modules will not have the attributes column set - // so initilaize with 0. - fieldValues[10] = "0"; - } - fields = String.Join(",", fieldValues); - break; - } - case "WixMedia": - break; - default: - fields = String.Join(",", row.Fields.Select(SafeConvertField)); - break; - } - - if (fields != null) - { - yield return $"{row.Table.Name}:{fields}"; - } - } - - private static IEnumerable TupleToStrings(IntermediateTuple tuple, Dictionary assemblyTuplesByFileId) - { - var name = tuple.Definition.Type == TupleDefinitionType.SummaryInformation ? "_SummaryInformation" : tuple.Definition.Name; - var id = tuple.Id?.Id ?? String.Empty; - - string fields; - switch (tuple.Definition.Name) - { - // Massage output to match WiX v3 rows and v4 tuples. - // - case "Component": - { - var componentTuple = (ComponentTuple)tuple; - var attributes = ComponentLocation.Either == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; - attributes |= ComponentLocation.SourceOnly == componentTuple.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; - attributes |= ComponentKeyPathType.Registry == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; - attributes |= ComponentKeyPathType.OdbcDataSource == componentTuple.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; - attributes |= componentTuple.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; - attributes |= componentTuple.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; - attributes |= componentTuple.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; - attributes |= componentTuple.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; - attributes |= componentTuple.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; - attributes |= componentTuple.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; - attributes |= componentTuple.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - attributes |= componentTuple.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - - fields = String.Join(",", - componentTuple.ComponentId, - componentTuple.DirectoryRef, - attributes.ToString(), - componentTuple.Condition, - componentTuple.KeyPath - ); - break; - } - case "CustomAction": - { - var customActionTuple = (CustomActionTuple)tuple; - var type = customActionTuple.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; - type |= customActionTuple.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; - type |= customActionTuple.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; - type |= customActionTuple.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; - type |= customActionTuple.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; - type |= customActionTuple.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; - type |= CustomActionExecutionType.FirstSequence == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; - type |= CustomActionExecutionType.OncePerProcess == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; - type |= CustomActionExecutionType.ClientRepeat == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; - type |= CustomActionExecutionType.Deferred == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; - type |= CustomActionExecutionType.Rollback == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; - type |= CustomActionExecutionType.Commit == customActionTuple.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; - type |= CustomActionSourceType.File == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; - type |= CustomActionSourceType.Directory == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; - type |= CustomActionSourceType.Property == customActionTuple.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; - type |= CustomActionTargetType.Dll == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; - type |= CustomActionTargetType.Exe == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; - type |= CustomActionTargetType.TextData == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; - type |= CustomActionTargetType.JScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; - type |= CustomActionTargetType.VBScript == customActionTuple.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; - - fields = String.Join(",", - type.ToString(), - customActionTuple.Source, - customActionTuple.Target, - customActionTuple.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null - ); - break; - } - case "Directory": - { - var directoryTuple = (DirectoryTuple)tuple; - - if (!String.IsNullOrEmpty(directoryTuple.ComponentGuidGenerationSeed)) - { - yield return $"WixDirectory:{directoryTuple.Id.Id},{directoryTuple.ComponentGuidGenerationSeed}"; - } - - fields = String.Join(",", directoryTuple.ParentDirectoryRef, directoryTuple.Name, directoryTuple.ShortName, directoryTuple.SourceName, directoryTuple.SourceShortName); - break; - } - case "Feature": - { - var featureTuple = (FeatureTuple)tuple; - var attributes = featureTuple.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; - attributes |= featureTuple.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; - attributes |= FeatureInstallDefault.FollowParent == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; - attributes |= FeatureInstallDefault.Source == featureTuple.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; - attributes |= FeatureTypicalDefault.Advertise == featureTuple.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; - - fields = String.Join(",", - featureTuple.ParentFeatureRef, - featureTuple.Title, - featureTuple.Description, - featureTuple.Display.ToString(), - featureTuple.Level.ToString(), - featureTuple.DirectoryRef, - attributes.ToString()); - break; - } - case "File": - { - var fileTuple = (FileTuple)tuple; - - if (fileTuple.BindPath != null) - { - yield return $"BindImage:{fileTuple.Id.Id},{fileTuple.BindPath}"; - } - - if (fileTuple.FontTitle != null) - { - yield return $"Font:{fileTuple.Id.Id},{fileTuple.FontTitle}"; - } - - if (fileTuple.SelfRegCost.HasValue) - { - yield return $"SelfReg:{fileTuple.Id.Id},{fileTuple.SelfRegCost}"; - } - - int? assemblyAttributes = null; - if (assemblyTuplesByFileId.TryGetValue(fileTuple.Id.Id, out var assemblyTuple)) - { - if (assemblyTuple.Type == AssemblyType.DotNetAssembly) - { - assemblyAttributes = 0; - } - else if (assemblyTuple.Type == AssemblyType.Win32Assembly) - { - assemblyAttributes = 1; - } - } - - yield return "WixFile:" + String.Join(",", - fileTuple.Id.Id, - assemblyAttributes, - assemblyTuple?.ManifestFileRef, - assemblyTuple?.ApplicationFileRef, - fileTuple.DirectoryRef, - fileTuple.DiskId, - fileTuple.Source.Path, - null, // assembly processor arch - fileTuple.PatchGroup, - (fileTuple.Attributes & FileTupleAttributes.GeneratedShortFileName) != 0 ? 1 : 0, - (int)fileTuple.PatchAttributes, - fileTuple.RetainLengths, - fileTuple.IgnoreOffsets, - fileTuple.IgnoreLengths, - fileTuple.RetainOffsets - ); - - var fileAttributes = 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; - fileAttributes |= (fileTuple.Attributes & FileTupleAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; - - fields = String.Join(",", - fileTuple.ComponentRef, - fileTuple.Name, - fileTuple.FileSize.ToString(), - fileTuple.Version, - fileTuple.Language, - fileAttributes); - break; - } - - case "Media": - fields = String.Join(",", tuple.Fields.Skip(1).Select(SafeConvertField)); - break; - - case "Assembly": - { - var assemblyTuple = (AssemblyTuple)tuple; - - id = null; - name = "MsiAssembly"; - fields = String.Join(",", assemblyTuple.ComponentRef, assemblyTuple.FeatureRef, assemblyTuple.ManifestFileRef, assemblyTuple.ApplicationFileRef, assemblyTuple.Type == AssemblyType.Win32Assembly ? 1 : 0); - break; - } - case "RegLocator": - { - var locatorTuple = (RegLocatorTuple)tuple; - - fields = String.Join(",", (int)locatorTuple.Root, locatorTuple.Key, locatorTuple.Name, (int)locatorTuple.Type, locatorTuple.Win64); - break; - } - case "Registry": - { - var registryTuple = (RegistryTuple)tuple; - var value = registryTuple.Value; - - switch (registryTuple.ValueType) - { - case RegistryValueType.Binary: - value = String.Concat("#x", value); - break; - case RegistryValueType.Expandable: - value = String.Concat("#%", value); - break; - case RegistryValueType.Integer: - value = String.Concat("#", value); - break; - case RegistryValueType.MultiString: - switch (registryTuple.ValueAction) - { - case RegistryValueActionType.Append: - value = String.Concat("[~]", value); - break; - case RegistryValueActionType.Prepend: - value = String.Concat(value, "[~]"); - break; - case RegistryValueActionType.Write: - default: - if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) - { - value = String.Concat("[~]", value, "[~]"); - } - break; - } - break; - case RegistryValueType.String: - // escape the leading '#' character for string registry keys - if (null != value && value.StartsWith("#", StringComparison.Ordinal)) - { - value = String.Concat("#", value); - } - break; - } - - fields = String.Join(",", - ((int)registryTuple.Root).ToString(), - registryTuple.Key, - registryTuple.Name, - value, - registryTuple.ComponentRef - ); - break; - } - - case "RemoveRegistry": - { - var removeRegistryTuple = (RemoveRegistryTuple)tuple; - fields = String.Join(",", - ((int)removeRegistryTuple.Root).ToString(), - removeRegistryTuple.Key, - removeRegistryTuple.Name, - removeRegistryTuple.ComponentRef - ); - break; - } - - case "ServiceControl": - { - var serviceControlTuple = (ServiceControlTuple)tuple; - - var events = serviceControlTuple.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; - events |= serviceControlTuple.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; - events |= serviceControlTuple.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; - events |= serviceControlTuple.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; - events |= serviceControlTuple.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; - events |= serviceControlTuple.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; - - fields = String.Join(",", - serviceControlTuple.Name, - events.ToString(), - serviceControlTuple.Arguments, - serviceControlTuple.Wait == true ? "1" : "0", - serviceControlTuple.ComponentRef - ); - break; - } - - case "ServiceInstall": - { - var serviceInstallTuple = (ServiceInstallTuple)tuple; - - var errorControl = (int)serviceInstallTuple.ErrorControl; - errorControl |= serviceInstallTuple.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; - - var serviceType = (int)serviceInstallTuple.ServiceType; - serviceType |= serviceInstallTuple.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; - - fields = String.Join(",", - serviceInstallTuple.Name, - serviceInstallTuple.DisplayName, - serviceType.ToString(), - ((int)serviceInstallTuple.StartType).ToString(), - errorControl.ToString(), - serviceInstallTuple.LoadOrderGroup, - serviceInstallTuple.Dependencies, - serviceInstallTuple.StartName, - serviceInstallTuple.Password, - serviceInstallTuple.Arguments, - serviceInstallTuple.ComponentRef, - serviceInstallTuple.Description - ); - break; - } - - case "Upgrade": - { - var upgradeTuple = (UpgradeTuple)tuple; - - var attributes = upgradeTuple.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; - attributes |= upgradeTuple.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; - attributes |= upgradeTuple.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; - attributes |= upgradeTuple.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; - attributes |= upgradeTuple.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; - attributes |= upgradeTuple.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; - - fields = String.Join(",", - upgradeTuple.VersionMin, - upgradeTuple.VersionMax, - upgradeTuple.Language, - attributes.ToString(), - upgradeTuple.Remove, - upgradeTuple.ActionProperty - ); - break; - } - - case "WixAction": - { - var wixActionTuple = (WixActionTuple)tuple; - var data = wixActionTuple.Fields[(int)WixActionTupleFields.SequenceTable].AsObject(); - var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionTuple.SequenceTable; - - fields = String.Join(",", - sequenceTableAsInt, - wixActionTuple.Action, - wixActionTuple.Condition, - wixActionTuple.Sequence?.ToString() ?? String.Empty, - wixActionTuple.Before, - wixActionTuple.After, - wixActionTuple.Overridable == true ? "1" : "0" - ); - break; - } - - case "WixComplexReference": - { - var wixComplexReferenceTuple = (WixComplexReferenceTuple)tuple; - fields = String.Join(",", - wixComplexReferenceTuple.Parent, - (int)wixComplexReferenceTuple.ParentType, - wixComplexReferenceTuple.ParentLanguage, - wixComplexReferenceTuple.Child, - (int)wixComplexReferenceTuple.ChildType, - wixComplexReferenceTuple.IsPrimary ? "1" : "0" - ); - break; - } - - case "WixProperty": - { - var wixPropertyTuple = (WixPropertyTuple)tuple; - var attributes = wixPropertyTuple.Admin ? 0x1 : 0; - attributes |= wixPropertyTuple.Hidden ? 0x2 : 0; - attributes |= wixPropertyTuple.Secure ? 0x4 : 0; - - fields = String.Join(",", - wixPropertyTuple.PropertyRef, - attributes.ToString() - ); - break; - } - - default: - fields = String.Join(",", tuple.Fields.Select(SafeConvertField)); - break; - } - - fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; - yield return $"{name}:{fields}"; - } - - private static SequenceTable SequenceStringToSequenceTable(object sequenceString) - { - switch (sequenceString) - { - case "AdminExecuteSequence": - return SequenceTable.AdminExecuteSequence; - case "AdminUISequence": - return SequenceTable.AdminUISequence; - case "AdvtExecuteSequence": - return SequenceTable.AdvertiseExecuteSequence; - case "InstallExecuteSequence": - return SequenceTable.InstallExecuteSequence; - case "InstallUISequence": - return SequenceTable.InstallUISequence; - default: - throw new ArgumentException($"Unknown sequence: {sequenceString}"); - } - } - - private static string SafeConvertField(Wix3.Field field) - { - return field?.Data?.ToString(); - } - - private static string SafeConvertField(IntermediateField field) - { - var data = field.AsObject(); - if (data is IntermediateFieldPathValue path) - { - return path.Path; - } - - return data?.ToString(); - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : String.Empty, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty - }; - } - } -} diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout deleted file mode 100644 index da64b8af..00000000 Binary files a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixout and /dev/null differ diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj deleted file mode 100644 index 8af13dc8..00000000 --- a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wixproj +++ /dev/null @@ -1,47 +0,0 @@ - - - - Debug - x86 - 3.10 - d59f1c1e-9238-49fa-bfa2-ec1d9c2dda1d - 2.0 - TupleizerWixout - Package - - - bin\$(Configuration)\ - obj\$(Configuration)\ - Debug - - - bin\$(Configuration)\ - obj\$(Configuration)\ - - - - - - - $(WixExtDir)\WixUtilExtension.dll - WixUtilExtension - - - $(WixExtDir)\WixNetFxExtension.dll - WixNetFxExtension - - - - - - - - - \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs b/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs deleted file mode 100644 index 1006a254..00000000 --- a/src/test/WixToolsetTest.Converters.Tupleizer/TestData/Integration/test.wxs +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj b/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj deleted file mode 100644 index fa6a6bcf..00000000 --- a/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.csproj +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - net461 - false - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject b/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject deleted file mode 100644 index bb70cf0f..00000000 --- a/src/test/WixToolsetTest.Converters.Tupleizer/WixToolsetTest.Converters.Tupleizer.v3.ncrunchproject +++ /dev/null @@ -1,9 +0,0 @@ - - - - - WixToolsetTest.Converters.Tupleizer.ConvertTuplesFixture.CanLoadWixoutAndConvertToIntermediate - - - - \ No newline at end of file -- cgit v1.2.3-55-g6feb From 026c2fdb94a0333bfb840decee9464ba2f839705 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Thu, 25 Jun 2020 15:47:34 -0700 Subject: The Great Tuple to Symbol File Rename (tm) --- .../ConvertSymbols.cs | 814 +++++++++++++++++++++ .../ConvertTuples.cs | 814 --------------------- .../ConvertSymbolsFixture.cs | 606 +++++++++++++++ .../ConvertTuplesFixture.cs | 606 --------------- 4 files changed, 1420 insertions(+), 1420 deletions(-) create mode 100644 src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs delete mode 100644 src/WixToolset.Converters.Symbolizer/ConvertTuples.cs create mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs new file mode 100644 index 00000000..76a0440f --- /dev/null +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -0,0 +1,814 @@ +// 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.Converters.Symbolizer +{ + using System; + using System.Collections.Generic; + using System.Linq; + using WixToolset.Data; + using WixToolset.Data.Symbols; + using WixToolset.Data.WindowsInstaller; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + + public static class ConvertSymbols + { + public static Intermediate ConvertFile(string path) + { + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + return ConvertOutput(output); + } + + public static Intermediate ConvertOutput(Wix3.Output output) + { + var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); + + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + var componentsById = IndexById(output, "Component"); + var bindPathsById = IndexById(output, "BindPath"); + var fontsById = IndexById(output, "Font"); + var selfRegById = IndexById(output, "SelfReg"); + var wixDirectoryById = IndexById(output, "WixDirectory"); + var wixFileById = IndexById(output, "WixFile"); + + foreach (Wix3.Table table in output.Tables) + { + foreach (Wix3.Row row in table.Rows) + { + var symbol = GenerateSymbolFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); + if (symbol != null) + { + section.Symbols.Add(symbol); + } + } + } + + return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add(FieldAsInt(row, 0), row); + } + } + + return wixMediaByDiskId; + } + + private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row + { + var byId = new Dictionary(); + var table = output.Tables[tableName]; + + if (table != null) + { + foreach (T row in table.Rows) + { + byId.Add(FieldAsString(row, 0), row); + } + } + + return byId; + } + + private static IntermediateSymbol GenerateSymbolFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) + { + var name = row.Table.Name; + switch (name) + { + case "_SummaryInformation": + return DefaultSymbolFromRow(typeof(SummaryInformationSymbol), row, columnZeroIsId: false); + case "ActionText": + return DefaultSymbolFromRow(typeof(ActionTextSymbol), row, columnZeroIsId: false); + case "AppId": + return DefaultSymbolFromRow(typeof(AppIdSymbol), row, columnZeroIsId: false); + case "AppSearch": + return DefaultSymbolFromRow(typeof(AppSearchSymbol), row, columnZeroIsId: false); + case "Billboard": + return DefaultSymbolFromRow(typeof(BillboardSymbol), row, columnZeroIsId: true); + case "Binary": + return DefaultSymbolFromRow(typeof(BinarySymbol), row, columnZeroIsId: true); + case "BindPath": + return null; + case "CCPSearch": + return DefaultSymbolFromRow(typeof(CCPSearchSymbol), row, columnZeroIsId: true); + case "Class": + return DefaultSymbolFromRow(typeof(ClassSymbol), row, columnZeroIsId: false); + case "CompLocator": + return DefaultSymbolFromRow(typeof(CompLocatorSymbol), row, columnZeroIsId: false); + case "Component": + { + var attributes = FieldAsNullableInt(row, 3); + + var location = ComponentLocation.LocalOnly; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) + { + location = ComponentLocation.SourceOnly; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) + { + location = ComponentLocation.Either; + } + + var keyPath = FieldAsString(row, 5); + var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) + { + keyPathType = ComponentKeyPathType.Registry; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) + { + keyPathType = ComponentKeyPathType.OdbcDataSource; + } + + return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentId = FieldAsString(row, 1), + DirectoryRef = FieldAsString(row, 2), + Condition = FieldAsString(row, 4), + KeyPath = keyPath, + Location = location, + DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, + NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, + Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, + SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, + Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, + Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, + UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, + Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, + KeyPathType = keyPathType, + }; + } + + case "Condition": + return DefaultSymbolFromRow(typeof(ConditionSymbol), row, columnZeroIsId: false); + case "CreateFolder": + return DefaultSymbolFromRow(typeof(CreateFolderSymbol), row, columnZeroIsId: false); + case "CustomAction": + { + var caType = FieldAsInt(row, 1); + var executionType = DetermineCustomActionExecutionType(caType); + var sourceType = DetermineCustomActionSourceType(caType); + var targetType = DetermineCustomActionTargetType(caType); + + return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ExecutionType = executionType, + SourceType = sourceType, + Source = FieldAsString(row, 2), + TargetType = targetType, + Target = FieldAsString(row, 3), + Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, + TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, + Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, + IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, + Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, + Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, + }; + } + + case "Directory": + { + var id = FieldAsString(row, 0); + var splits = SplitDefaultDir(FieldAsString(row, 2)); + + var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ParentDirectoryRef = FieldAsString(row, 1), + Name = splits[0], + ShortName = splits[1], + SourceName = splits[2], + SourceShortName = splits[3] + }; + + if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) + { + symbol.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); + } + + return symbol; + } + case "DrLocator": + return DefaultSymbolFromRow(typeof(DrLocatorSymbol), row, columnZeroIsId: false); + case "DuplicateFile": + return DefaultSymbolFromRow(typeof(DuplicateFileSymbol), row, columnZeroIsId: true); + case "Error": + return DefaultSymbolFromRow(typeof(ErrorSymbol), row, columnZeroIsId: false); + case "Extension": + return DefaultSymbolFromRow(typeof(ExtensionSymbol), row, columnZeroIsId: false); + case "Feature": + { + var attributes = FieldAsInt(row, 7); + var installDefault = FeatureInstallDefault.Local; + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) + { + installDefault = FeatureInstallDefault.FollowParent; + } + else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) + { + installDefault = FeatureInstallDefault.Source; + } + + return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ParentFeatureRef = FieldAsString(row, 1), + Title = FieldAsString(row, 2), + Description = FieldAsString(row, 3), + Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), + Level = FieldAsInt(row, 5), + DirectoryRef = FieldAsString(row, 6), + DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, + DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, + InstallDefault = installDefault, + TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, + }; + } + + case "FeatureComponents": + return DefaultSymbolFromRow(typeof(FeatureComponentsSymbol), row, columnZeroIsId: false); + case "File": + { + var attributes = FieldAsNullableInt(row, 6); + + FileSymbolAttributes symbolAttributes = 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileSymbolAttributes.ReadOnly : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileSymbolAttributes.Hidden : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileSymbolAttributes.System : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileSymbolAttributes.Vital : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileSymbolAttributes.Checksum : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileSymbolAttributes.Uncompressed : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileSymbolAttributes.Compressed : 0; + + var id = FieldAsString(row, 0); + + var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + { + ComponentRef = FieldAsString(row, 1), + Name = FieldAsString(row, 2), + FileSize = FieldAsInt(row, 3), + Version = FieldAsString(row, 4), + Language = FieldAsString(row, 5), + Attributes = symbolAttributes + }; + + if (bindPathsById.TryGetValue(id, out var bindPathRow)) + { + symbol.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; + } + + if (fontsById.TryGetValue(id, out var fontRow)) + { + symbol.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; + } + + if (selfRegById.TryGetValue(id, out var selfRegRow)) + { + symbol.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; + } + + if (wixFileById.TryGetValue(id, out var wixFileRow)) + { + symbol.DirectoryRef = FieldAsString(wixFileRow, 4); + symbol.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; + symbol.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; + symbol.PatchGroup = FieldAsInt(wixFileRow, 8); + symbol.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileSymbolAttributes.GeneratedShortFileName : 0; + symbol.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); + } + + return symbol; + } + case "Font": + return null; + case "Icon": + return DefaultSymbolFromRow(typeof(IconSymbol), row, columnZeroIsId: true); + case "IniLocator": + return DefaultSymbolFromRow(typeof(IniLocatorSymbol), row, columnZeroIsId: false); + case "LockPermissions": + return DefaultSymbolFromRow(typeof(LockPermissionsSymbol), row, columnZeroIsId: false); + case "Media": + { + var diskId = FieldAsInt(row, 0); + var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) + { + DiskId = diskId, + LastSequence = FieldAsNullableInt(row, 1), + DiskPrompt = FieldAsString(row, 2), + Cabinet = FieldAsString(row, 3), + VolumeLabel = FieldAsString(row, 4), + Source = FieldAsString(row, 5) + }; + + if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) + { + var compressionLevel = FieldAsString(wixMediaRow, 1); + + symbol.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); + symbol.Layout = wixMediaRow.Layout; + } + + return symbol; + } + case "MIME": + return DefaultSymbolFromRow(typeof(MIMESymbol), row, columnZeroIsId: false); + case "ModuleIgnoreTable": + return DefaultSymbolFromRow(typeof(ModuleIgnoreTableSymbol), row, columnZeroIsId: true); + case "MoveFile": + return DefaultSymbolFromRow(typeof(MoveFileSymbol), row, columnZeroIsId: true); + case "MsiAssembly": + { + var componentId = FieldAsString(row, 0); + if (componentsById.TryGetValue(componentId, out var componentRow)) + { + return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) + { + ComponentRef = componentId, + FeatureRef = FieldAsString(row, 1), + ManifestFileRef = FieldAsString(row, 2), + ApplicationFileRef = FieldAsString(row, 3), + Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, + }; + } + + return null; + } + case "MsiLockPermissionsEx": + return DefaultSymbolFromRow(typeof(MsiLockPermissionsExSymbol), row, columnZeroIsId: true); + case "MsiShortcutProperty": + return DefaultSymbolFromRow(typeof(MsiShortcutPropertySymbol), row, columnZeroIsId: true); + case "ODBCDataSource": + return DefaultSymbolFromRow(typeof(ODBCDataSourceSymbol), row, columnZeroIsId: true); + case "ODBCDriver": + return DefaultSymbolFromRow(typeof(ODBCDriverSymbol), row, columnZeroIsId: true); + case "ODBCTranslator": + return DefaultSymbolFromRow(typeof(ODBCTranslatorSymbol), row, columnZeroIsId: true); + case "ProgId": + return DefaultSymbolFromRow(typeof(ProgIdSymbol), row, columnZeroIsId: false); + case "Property": + return DefaultSymbolFromRow(typeof(PropertySymbol), row, columnZeroIsId: true); + case "PublishComponent": + return DefaultSymbolFromRow(typeof(PublishComponentSymbol), row, columnZeroIsId: false); + case "Registry": + { + var value = FieldAsString(row, 4); + var valueType = RegistryValueType.String; + var valueAction = RegistryValueActionType.Write; + + if (!String.IsNullOrEmpty(value)) + { + if (value.StartsWith("#x", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Binary; + value = value.Substring(2); + } + else if (value.StartsWith("#%", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Expandable; + value = value.Substring(2); + } + else if (value.StartsWith("#", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Integer; + value = value.Substring(1); + } + else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3, value.Length - 6); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Write; + } + else if (value.StartsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Append; + } + else if (value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(0, value.Length - 3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Prepend; + } + } + + return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Value = value, + ComponentRef = FieldAsString(row, 5), + ValueAction = valueAction, + ValueType = valueType, + }; + } + case "RegLocator": + { + var type = FieldAsInt(row, 4); + + return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Type = (RegLocatorType)(type & 0xF), + Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit + }; + } + case "RemoveFile": + { + var installMode = FieldAsInt(row, 4); + return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileName = FieldAsString(row, 2), + DirProperty = FieldAsString(row, 3), + OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, + OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null + }; + } + case "RemoveRegistry": + { + return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Action = RemoveRegistryActionType.RemoveOnInstall, + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + ComponentRef = FieldAsString(row, 4), + }; + } + + case "ReserveCost": + return DefaultSymbolFromRow(typeof(ReserveCostSymbol), row, columnZeroIsId: true); + case "SelfReg": + return null; + case "ServiceControl": + { + var events = FieldAsInt(row, 2); + var wait = FieldAsNullableInt(row, 4); + return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + Name = FieldAsString(row, 1), + Arguments = FieldAsString(row, 3), + Wait = !wait.HasValue || wait.Value == 1, + ComponentRef = FieldAsString(row, 5), + InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, + UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, + InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, + UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, + InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, + UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, + }; + } + + case "ServiceInstall": + return DefaultSymbolFromRow(typeof(ServiceInstallSymbol), row, columnZeroIsId: true); + case "Shortcut": + { + var splitName = FieldAsString(row, 2).Split('|'); + + return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + DirectoryRef = FieldAsString(row, 1), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, + ComponentRef = FieldAsString(row, 3), + Target = FieldAsString(row, 4), + Arguments = FieldAsString(row, 5), + Description = FieldAsString(row, 6), + Hotkey = FieldAsNullableInt(row, 7), + IconRef = FieldAsString(row, 8), + IconIndex = FieldAsNullableInt(row, 9), + Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), + WorkingDirectory = FieldAsString(row, 11), + DisplayResourceDll = FieldAsString(row, 12), + DisplayResourceId = FieldAsNullableInt(row, 13), + DescriptionResourceDll = FieldAsString(row, 14), + DescriptionResourceId= FieldAsNullableInt(row, 15), + }; + } + case "Signature": + return DefaultSymbolFromRow(typeof(SignatureSymbol), row, columnZeroIsId: true); + case "UIText": + return DefaultSymbolFromRow(typeof(UITextSymbol), row, columnZeroIsId: true); + case "Upgrade": + { + var attributes = FieldAsInt(row, 4); + return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + UpgradeCode = FieldAsString(row, 0), + VersionMin = FieldAsString(row, 1), + VersionMax = FieldAsString(row, 2), + Language = FieldAsString(row, 3), + Remove = FieldAsString(row, 5), + ActionProperty = FieldAsString(row, 6), + MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, + OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, + IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, + VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, + VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, + ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, + }; + } + case "Verb": + return DefaultSymbolFromRow(typeof(VerbSymbol), row, columnZeroIsId: false); + case "WixAction": + { + var sequenceTable = FieldAsString(row, 0); + return new WixActionSymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), + Action = FieldAsString(row, 1), + Condition = FieldAsString(row, 2), + Sequence = FieldAsNullableInt(row, 3), + Before = FieldAsString(row, 4), + After = FieldAsString(row, 5), + Overridable = FieldAsNullableInt(row, 6) != 0, + }; + } + case "WixBootstrapperApplication": + return DefaultSymbolFromRow(typeof(WixBootstrapperApplicationSymbol), row, columnZeroIsId: true); + case "WixBundleContainer": + return DefaultSymbolFromRow(typeof(WixBundleContainerSymbol), row, columnZeroIsId: true); + case "WixBundleVariable": + return DefaultSymbolFromRow(typeof(WixBundleVariableSymbol), row, columnZeroIsId: true); + case "WixChainItem": + return DefaultSymbolFromRow(typeof(WixChainItemSymbol), row, columnZeroIsId: true); + case "WixCustomTable": + return DefaultSymbolFromRow(typeof(WixCustomTableSymbol), row, columnZeroIsId: true); + case "WixDirectory": + return null; + case "WixFile": + return null; + case "WixInstanceTransforms": + return DefaultSymbolFromRow(typeof(WixInstanceTransformsSymbol), row, columnZeroIsId: true); + case "WixMedia": + return null; + case "WixMerge": + return DefaultSymbolFromRow(typeof(WixMergeSymbol), row, columnZeroIsId: true); + case "WixPatchBaseline": + return DefaultSymbolFromRow(typeof(WixPatchBaselineSymbol), row, columnZeroIsId: true); + case "WixProperty": + { + var attributes = FieldAsInt(row, 1); + return new WixPropertySymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + PropertyRef = FieldAsString(row, 0), + Admin = (attributes & 0x1) == 0x1, + Hidden = (attributes & 0x2) == 0x2, + Secure = (attributes & 0x4) == 0x4, + }; + } + case "WixSuppressModularization": + return DefaultSymbolFromRow(typeof(WixSuppressModularizationSymbol), row, columnZeroIsId: true); + case "WixUI": + return DefaultSymbolFromRow(typeof(WixUISymbol), row, columnZeroIsId: true); + case "WixVariable": + return DefaultSymbolFromRow(typeof(WixVariableSymbol), row, columnZeroIsId: true); + default: + return GenericSymbolFromCustomRow(row, columnZeroIsId: false); + } + } + + private static CustomActionTargetType DetermineCustomActionTargetType(int type) + { + var targetType = default(CustomActionTargetType); + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) + { + targetType = CustomActionTargetType.VBScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) + { + targetType = CustomActionTargetType.JScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) + { + targetType = CustomActionTargetType.TextData; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) + { + targetType = CustomActionTargetType.Exe; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) + { + targetType = CustomActionTargetType.Dll; + } + + return targetType; + } + + private static CustomActionSourceType DetermineCustomActionSourceType(int type) + { + var sourceType = CustomActionSourceType.Binary; + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) + { + sourceType = CustomActionSourceType.Property; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) + { + sourceType = CustomActionSourceType.Directory; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) + { + sourceType = CustomActionSourceType.File; + } + + return sourceType; + } + + private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) + { + var executionType = CustomActionExecutionType.Immediate; + + if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) + { + executionType = CustomActionExecutionType.Commit; + } + else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) + { + executionType = CustomActionExecutionType.Rollback; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) + { + executionType = CustomActionExecutionType.Deferred; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) + { + executionType = CustomActionExecutionType.ClientRepeat; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) + { + executionType = CustomActionExecutionType.OncePerProcess; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) + { + executionType = CustomActionExecutionType.FirstSequence; + } + + return executionType; + } + + private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) + { + switch (columnType) + { + case Wix3.ColumnType.Number: + return IntermediateFieldType.Number; + case Wix3.ColumnType.Object: + return IntermediateFieldType.Path; + case Wix3.ColumnType.Unknown: + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Preserved: + default: + return IntermediateFieldType.String; + } + } + + private static IntermediateSymbol DefaultSymbolFromRow(Type symbolType, Wix3.Row row, bool columnZeroIsId) + { + var symbol = Activator.CreateInstance(symbolType) as IntermediateSymbol; + + SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); + + symbol.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); + return symbol; + } + + private static IntermediateSymbol GenericSymbolFromCustomRow(Wix3.Row row, bool columnZeroIsId) + { + var columnDefinitions = row.Table.Definition.Columns.Cast(); + var fieldDefinitions = columnDefinitions.Select(columnDefinition => + new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); + var symbolDefinition = new IntermediateSymbolDefinition(row.Table.Name, fieldDefinitions, null); + var symbol = new IntermediateSymbol(symbolDefinition, SourceLineNumber4(row.SourceLineNumbers)); + + SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); + + return symbol; + } + + private static void SetSymbolFieldsFromRow(Wix3.Row row, IntermediateSymbol symbol, bool columnZeroIsId) + { + int offset = 0; + if (columnZeroIsId) + { + symbol.Id = GetIdentifierForRow(row); + offset = 1; + } + + for (var i = offset; i < row.Fields.Length; ++i) + { + var column = row.Fields[i].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + symbol.Set(i - offset, FieldAsString(row, i)); + break; + case Wix3.ColumnType.Number: + int? nullableValue = FieldAsNullableInt(row, i); + // TODO: Consider whether null values should be coerced to their default value when + // a column is not nullable. For now, just pass through the null. + //int value = FieldAsInt(row, i); + //symbol.Set(i - offset, column.IsNullable ? nullableValue : value); + symbol.Set(i - offset, nullableValue); + break; + case Wix3.ColumnType.Unknown: + break; + } + } + } + + private static Identifier GetIdentifierForRow(Wix3.Row row) + { + var column = row.Fields[0].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); + case Wix3.ColumnType.Number: + return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); + default: + return null; + } + } + + private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) + { + switch (outputType) + { + case Wix3.OutputType.Bundle: + return SectionType.Bundle; + case Wix3.OutputType.Module: + return SectionType.Module; + case Wix3.OutputType.Patch: + return SectionType.Patch; + case Wix3.OutputType.PatchCreation: + return SectionType.PatchCreation; + case Wix3.OutputType.Product: + return SectionType.Product; + case Wix3.OutputType.Transform: + case Wix3.OutputType.Unknown: + default: + return SectionType.Unknown; + } + } + + private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) + { + return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); + } + + private static string FieldAsString(Wix3.Row row, int column) + { + return (string)row[column]; + } + + private static int FieldAsInt(Wix3.Row row, int column) + { + return Convert.ToInt32(row[column]); + } + + private static int? FieldAsNullableInt(Wix3.Row row, int column) + { + var field = row.Fields[column]; + if (field.Data == null) + { + return null; + } + else + { + return Convert.ToInt32(field.Data); + } + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : null, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : null + }; + } + } +} diff --git a/src/WixToolset.Converters.Symbolizer/ConvertTuples.cs b/src/WixToolset.Converters.Symbolizer/ConvertTuples.cs deleted file mode 100644 index 76a0440f..00000000 --- a/src/WixToolset.Converters.Symbolizer/ConvertTuples.cs +++ /dev/null @@ -1,814 +0,0 @@ -// 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.Converters.Symbolizer -{ - using System; - using System.Collections.Generic; - using System.Linq; - using WixToolset.Data; - using WixToolset.Data.Symbols; - using WixToolset.Data.WindowsInstaller; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - - public static class ConvertSymbols - { - public static Intermediate ConvertFile(string path) - { - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - return ConvertOutput(output); - } - - public static Intermediate ConvertOutput(Wix3.Output output) - { - var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); - - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - var componentsById = IndexById(output, "Component"); - var bindPathsById = IndexById(output, "BindPath"); - var fontsById = IndexById(output, "Font"); - var selfRegById = IndexById(output, "SelfReg"); - var wixDirectoryById = IndexById(output, "WixDirectory"); - var wixFileById = IndexById(output, "WixFile"); - - foreach (Wix3.Table table in output.Tables) - { - foreach (Wix3.Row row in table.Rows) - { - var symbol = GenerateSymbolFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); - if (symbol != null) - { - section.Symbols.Add(symbol); - } - } - } - - return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add(FieldAsInt(row, 0), row); - } - } - - return wixMediaByDiskId; - } - - private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row - { - var byId = new Dictionary(); - var table = output.Tables[tableName]; - - if (table != null) - { - foreach (T row in table.Rows) - { - byId.Add(FieldAsString(row, 0), row); - } - } - - return byId; - } - - private static IntermediateSymbol GenerateSymbolFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) - { - var name = row.Table.Name; - switch (name) - { - case "_SummaryInformation": - return DefaultSymbolFromRow(typeof(SummaryInformationSymbol), row, columnZeroIsId: false); - case "ActionText": - return DefaultSymbolFromRow(typeof(ActionTextSymbol), row, columnZeroIsId: false); - case "AppId": - return DefaultSymbolFromRow(typeof(AppIdSymbol), row, columnZeroIsId: false); - case "AppSearch": - return DefaultSymbolFromRow(typeof(AppSearchSymbol), row, columnZeroIsId: false); - case "Billboard": - return DefaultSymbolFromRow(typeof(BillboardSymbol), row, columnZeroIsId: true); - case "Binary": - return DefaultSymbolFromRow(typeof(BinarySymbol), row, columnZeroIsId: true); - case "BindPath": - return null; - case "CCPSearch": - return DefaultSymbolFromRow(typeof(CCPSearchSymbol), row, columnZeroIsId: true); - case "Class": - return DefaultSymbolFromRow(typeof(ClassSymbol), row, columnZeroIsId: false); - case "CompLocator": - return DefaultSymbolFromRow(typeof(CompLocatorSymbol), row, columnZeroIsId: false); - case "Component": - { - var attributes = FieldAsNullableInt(row, 3); - - var location = ComponentLocation.LocalOnly; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) - { - location = ComponentLocation.SourceOnly; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) - { - location = ComponentLocation.Either; - } - - var keyPath = FieldAsString(row, 5); - var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) - { - keyPathType = ComponentKeyPathType.Registry; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) - { - keyPathType = ComponentKeyPathType.OdbcDataSource; - } - - return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentId = FieldAsString(row, 1), - DirectoryRef = FieldAsString(row, 2), - Condition = FieldAsString(row, 4), - KeyPath = keyPath, - Location = location, - DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, - NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, - Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, - SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, - Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, - Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, - UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, - Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, - KeyPathType = keyPathType, - }; - } - - case "Condition": - return DefaultSymbolFromRow(typeof(ConditionSymbol), row, columnZeroIsId: false); - case "CreateFolder": - return DefaultSymbolFromRow(typeof(CreateFolderSymbol), row, columnZeroIsId: false); - case "CustomAction": - { - var caType = FieldAsInt(row, 1); - var executionType = DetermineCustomActionExecutionType(caType); - var sourceType = DetermineCustomActionSourceType(caType); - var targetType = DetermineCustomActionTargetType(caType); - - return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ExecutionType = executionType, - SourceType = sourceType, - Source = FieldAsString(row, 2), - TargetType = targetType, - Target = FieldAsString(row, 3), - Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, - TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, - Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, - IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, - Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, - Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, - }; - } - - case "Directory": - { - var id = FieldAsString(row, 0); - var splits = SplitDefaultDir(FieldAsString(row, 2)); - - var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) - { - ParentDirectoryRef = FieldAsString(row, 1), - Name = splits[0], - ShortName = splits[1], - SourceName = splits[2], - SourceShortName = splits[3] - }; - - if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) - { - symbol.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); - } - - return symbol; - } - case "DrLocator": - return DefaultSymbolFromRow(typeof(DrLocatorSymbol), row, columnZeroIsId: false); - case "DuplicateFile": - return DefaultSymbolFromRow(typeof(DuplicateFileSymbol), row, columnZeroIsId: true); - case "Error": - return DefaultSymbolFromRow(typeof(ErrorSymbol), row, columnZeroIsId: false); - case "Extension": - return DefaultSymbolFromRow(typeof(ExtensionSymbol), row, columnZeroIsId: false); - case "Feature": - { - var attributes = FieldAsInt(row, 7); - var installDefault = FeatureInstallDefault.Local; - if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) - { - installDefault = FeatureInstallDefault.FollowParent; - } - else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) - { - installDefault = FeatureInstallDefault.Source; - } - - return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ParentFeatureRef = FieldAsString(row, 1), - Title = FieldAsString(row, 2), - Description = FieldAsString(row, 3), - Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), - Level = FieldAsInt(row, 5), - DirectoryRef = FieldAsString(row, 6), - DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, - DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, - InstallDefault = installDefault, - TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, - }; - } - - case "FeatureComponents": - return DefaultSymbolFromRow(typeof(FeatureComponentsSymbol), row, columnZeroIsId: false); - case "File": - { - var attributes = FieldAsNullableInt(row, 6); - - FileSymbolAttributes symbolAttributes = 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileSymbolAttributes.ReadOnly : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileSymbolAttributes.Hidden : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileSymbolAttributes.System : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileSymbolAttributes.Vital : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileSymbolAttributes.Checksum : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileSymbolAttributes.Uncompressed : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileSymbolAttributes.Compressed : 0; - - var id = FieldAsString(row, 0); - - var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) - { - ComponentRef = FieldAsString(row, 1), - Name = FieldAsString(row, 2), - FileSize = FieldAsInt(row, 3), - Version = FieldAsString(row, 4), - Language = FieldAsString(row, 5), - Attributes = symbolAttributes - }; - - if (bindPathsById.TryGetValue(id, out var bindPathRow)) - { - symbol.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; - } - - if (fontsById.TryGetValue(id, out var fontRow)) - { - symbol.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; - } - - if (selfRegById.TryGetValue(id, out var selfRegRow)) - { - symbol.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; - } - - if (wixFileById.TryGetValue(id, out var wixFileRow)) - { - symbol.DirectoryRef = FieldAsString(wixFileRow, 4); - symbol.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; - symbol.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; - symbol.PatchGroup = FieldAsInt(wixFileRow, 8); - symbol.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileSymbolAttributes.GeneratedShortFileName : 0; - symbol.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); - } - - return symbol; - } - case "Font": - return null; - case "Icon": - return DefaultSymbolFromRow(typeof(IconSymbol), row, columnZeroIsId: true); - case "IniLocator": - return DefaultSymbolFromRow(typeof(IniLocatorSymbol), row, columnZeroIsId: false); - case "LockPermissions": - return DefaultSymbolFromRow(typeof(LockPermissionsSymbol), row, columnZeroIsId: false); - case "Media": - { - var diskId = FieldAsInt(row, 0); - var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) - { - DiskId = diskId, - LastSequence = FieldAsNullableInt(row, 1), - DiskPrompt = FieldAsString(row, 2), - Cabinet = FieldAsString(row, 3), - VolumeLabel = FieldAsString(row, 4), - Source = FieldAsString(row, 5) - }; - - if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) - { - var compressionLevel = FieldAsString(wixMediaRow, 1); - - symbol.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); - symbol.Layout = wixMediaRow.Layout; - } - - return symbol; - } - case "MIME": - return DefaultSymbolFromRow(typeof(MIMESymbol), row, columnZeroIsId: false); - case "ModuleIgnoreTable": - return DefaultSymbolFromRow(typeof(ModuleIgnoreTableSymbol), row, columnZeroIsId: true); - case "MoveFile": - return DefaultSymbolFromRow(typeof(MoveFileSymbol), row, columnZeroIsId: true); - case "MsiAssembly": - { - var componentId = FieldAsString(row, 0); - if (componentsById.TryGetValue(componentId, out var componentRow)) - { - return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) - { - ComponentRef = componentId, - FeatureRef = FieldAsString(row, 1), - ManifestFileRef = FieldAsString(row, 2), - ApplicationFileRef = FieldAsString(row, 3), - Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, - }; - } - - return null; - } - case "MsiLockPermissionsEx": - return DefaultSymbolFromRow(typeof(MsiLockPermissionsExSymbol), row, columnZeroIsId: true); - case "MsiShortcutProperty": - return DefaultSymbolFromRow(typeof(MsiShortcutPropertySymbol), row, columnZeroIsId: true); - case "ODBCDataSource": - return DefaultSymbolFromRow(typeof(ODBCDataSourceSymbol), row, columnZeroIsId: true); - case "ODBCDriver": - return DefaultSymbolFromRow(typeof(ODBCDriverSymbol), row, columnZeroIsId: true); - case "ODBCTranslator": - return DefaultSymbolFromRow(typeof(ODBCTranslatorSymbol), row, columnZeroIsId: true); - case "ProgId": - return DefaultSymbolFromRow(typeof(ProgIdSymbol), row, columnZeroIsId: false); - case "Property": - return DefaultSymbolFromRow(typeof(PropertySymbol), row, columnZeroIsId: true); - case "PublishComponent": - return DefaultSymbolFromRow(typeof(PublishComponentSymbol), row, columnZeroIsId: false); - case "Registry": - { - var value = FieldAsString(row, 4); - var valueType = RegistryValueType.String; - var valueAction = RegistryValueActionType.Write; - - if (!String.IsNullOrEmpty(value)) - { - if (value.StartsWith("#x", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Binary; - value = value.Substring(2); - } - else if (value.StartsWith("#%", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Expandable; - value = value.Substring(2); - } - else if (value.StartsWith("#", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Integer; - value = value.Substring(1); - } - else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3, value.Length - 6); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Write; - } - else if (value.StartsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Append; - } - else if (value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(0, value.Length - 3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Prepend; - } - } - - return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Value = value, - ComponentRef = FieldAsString(row, 5), - ValueAction = valueAction, - ValueType = valueType, - }; - } - case "RegLocator": - { - var type = FieldAsInt(row, 4); - - return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Type = (RegLocatorType)(type & 0xF), - Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit - }; - } - case "RemoveFile": - { - var installMode = FieldAsInt(row, 4); - return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - ComponentRef = FieldAsString(row, 1), - FileName = FieldAsString(row, 2), - DirProperty = FieldAsString(row, 3), - OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, - OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null - }; - } - case "RemoveRegistry": - { - return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Action = RemoveRegistryActionType.RemoveOnInstall, - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - ComponentRef = FieldAsString(row, 4), - }; - } - - case "ReserveCost": - return DefaultSymbolFromRow(typeof(ReserveCostSymbol), row, columnZeroIsId: true); - case "SelfReg": - return null; - case "ServiceControl": - { - var events = FieldAsInt(row, 2); - var wait = FieldAsNullableInt(row, 4); - return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - Name = FieldAsString(row, 1), - Arguments = FieldAsString(row, 3), - Wait = !wait.HasValue || wait.Value == 1, - ComponentRef = FieldAsString(row, 5), - InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, - UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, - InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, - UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, - InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, - UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, - }; - } - - case "ServiceInstall": - return DefaultSymbolFromRow(typeof(ServiceInstallSymbol), row, columnZeroIsId: true); - case "Shortcut": - { - var splitName = FieldAsString(row, 2).Split('|'); - - return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - DirectoryRef = FieldAsString(row, 1), - Name = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortName = splitName.Length > 1 ? splitName[0] : null, - ComponentRef = FieldAsString(row, 3), - Target = FieldAsString(row, 4), - Arguments = FieldAsString(row, 5), - Description = FieldAsString(row, 6), - Hotkey = FieldAsNullableInt(row, 7), - IconRef = FieldAsString(row, 8), - IconIndex = FieldAsNullableInt(row, 9), - Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), - WorkingDirectory = FieldAsString(row, 11), - DisplayResourceDll = FieldAsString(row, 12), - DisplayResourceId = FieldAsNullableInt(row, 13), - DescriptionResourceDll = FieldAsString(row, 14), - DescriptionResourceId= FieldAsNullableInt(row, 15), - }; - } - case "Signature": - return DefaultSymbolFromRow(typeof(SignatureSymbol), row, columnZeroIsId: true); - case "UIText": - return DefaultSymbolFromRow(typeof(UITextSymbol), row, columnZeroIsId: true); - case "Upgrade": - { - var attributes = FieldAsInt(row, 4); - return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) - { - UpgradeCode = FieldAsString(row, 0), - VersionMin = FieldAsString(row, 1), - VersionMax = FieldAsString(row, 2), - Language = FieldAsString(row, 3), - Remove = FieldAsString(row, 5), - ActionProperty = FieldAsString(row, 6), - MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, - OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, - IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, - VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, - VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, - ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, - }; - } - case "Verb": - return DefaultSymbolFromRow(typeof(VerbSymbol), row, columnZeroIsId: false); - case "WixAction": - { - var sequenceTable = FieldAsString(row, 0); - return new WixActionSymbol(SourceLineNumber4(row.SourceLineNumbers)) - { - SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), - Action = FieldAsString(row, 1), - Condition = FieldAsString(row, 2), - Sequence = FieldAsNullableInt(row, 3), - Before = FieldAsString(row, 4), - After = FieldAsString(row, 5), - Overridable = FieldAsNullableInt(row, 6) != 0, - }; - } - case "WixBootstrapperApplication": - return DefaultSymbolFromRow(typeof(WixBootstrapperApplicationSymbol), row, columnZeroIsId: true); - case "WixBundleContainer": - return DefaultSymbolFromRow(typeof(WixBundleContainerSymbol), row, columnZeroIsId: true); - case "WixBundleVariable": - return DefaultSymbolFromRow(typeof(WixBundleVariableSymbol), row, columnZeroIsId: true); - case "WixChainItem": - return DefaultSymbolFromRow(typeof(WixChainItemSymbol), row, columnZeroIsId: true); - case "WixCustomTable": - return DefaultSymbolFromRow(typeof(WixCustomTableSymbol), row, columnZeroIsId: true); - case "WixDirectory": - return null; - case "WixFile": - return null; - case "WixInstanceTransforms": - return DefaultSymbolFromRow(typeof(WixInstanceTransformsSymbol), row, columnZeroIsId: true); - case "WixMedia": - return null; - case "WixMerge": - return DefaultSymbolFromRow(typeof(WixMergeSymbol), row, columnZeroIsId: true); - case "WixPatchBaseline": - return DefaultSymbolFromRow(typeof(WixPatchBaselineSymbol), row, columnZeroIsId: true); - case "WixProperty": - { - var attributes = FieldAsInt(row, 1); - return new WixPropertySymbol(SourceLineNumber4(row.SourceLineNumbers)) - { - PropertyRef = FieldAsString(row, 0), - Admin = (attributes & 0x1) == 0x1, - Hidden = (attributes & 0x2) == 0x2, - Secure = (attributes & 0x4) == 0x4, - }; - } - case "WixSuppressModularization": - return DefaultSymbolFromRow(typeof(WixSuppressModularizationSymbol), row, columnZeroIsId: true); - case "WixUI": - return DefaultSymbolFromRow(typeof(WixUISymbol), row, columnZeroIsId: true); - case "WixVariable": - return DefaultSymbolFromRow(typeof(WixVariableSymbol), row, columnZeroIsId: true); - default: - return GenericSymbolFromCustomRow(row, columnZeroIsId: false); - } - } - - private static CustomActionTargetType DetermineCustomActionTargetType(int type) - { - var targetType = default(CustomActionTargetType); - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) - { - targetType = CustomActionTargetType.VBScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) - { - targetType = CustomActionTargetType.JScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) - { - targetType = CustomActionTargetType.TextData; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) - { - targetType = CustomActionTargetType.Exe; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) - { - targetType = CustomActionTargetType.Dll; - } - - return targetType; - } - - private static CustomActionSourceType DetermineCustomActionSourceType(int type) - { - var sourceType = CustomActionSourceType.Binary; - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) - { - sourceType = CustomActionSourceType.Property; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) - { - sourceType = CustomActionSourceType.Directory; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) - { - sourceType = CustomActionSourceType.File; - } - - return sourceType; - } - - private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) - { - var executionType = CustomActionExecutionType.Immediate; - - if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) - { - executionType = CustomActionExecutionType.Commit; - } - else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) - { - executionType = CustomActionExecutionType.Rollback; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) - { - executionType = CustomActionExecutionType.Deferred; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) - { - executionType = CustomActionExecutionType.ClientRepeat; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) - { - executionType = CustomActionExecutionType.OncePerProcess; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) - { - executionType = CustomActionExecutionType.FirstSequence; - } - - return executionType; - } - - private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) - { - switch (columnType) - { - case Wix3.ColumnType.Number: - return IntermediateFieldType.Number; - case Wix3.ColumnType.Object: - return IntermediateFieldType.Path; - case Wix3.ColumnType.Unknown: - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Preserved: - default: - return IntermediateFieldType.String; - } - } - - private static IntermediateSymbol DefaultSymbolFromRow(Type symbolType, Wix3.Row row, bool columnZeroIsId) - { - var symbol = Activator.CreateInstance(symbolType) as IntermediateSymbol; - - SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); - - symbol.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); - return symbol; - } - - private static IntermediateSymbol GenericSymbolFromCustomRow(Wix3.Row row, bool columnZeroIsId) - { - var columnDefinitions = row.Table.Definition.Columns.Cast(); - var fieldDefinitions = columnDefinitions.Select(columnDefinition => - new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); - var symbolDefinition = new IntermediateSymbolDefinition(row.Table.Name, fieldDefinitions, null); - var symbol = new IntermediateSymbol(symbolDefinition, SourceLineNumber4(row.SourceLineNumbers)); - - SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); - - return symbol; - } - - private static void SetSymbolFieldsFromRow(Wix3.Row row, IntermediateSymbol symbol, bool columnZeroIsId) - { - int offset = 0; - if (columnZeroIsId) - { - symbol.Id = GetIdentifierForRow(row); - offset = 1; - } - - for (var i = offset; i < row.Fields.Length; ++i) - { - var column = row.Fields[i].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - symbol.Set(i - offset, FieldAsString(row, i)); - break; - case Wix3.ColumnType.Number: - int? nullableValue = FieldAsNullableInt(row, i); - // TODO: Consider whether null values should be coerced to their default value when - // a column is not nullable. For now, just pass through the null. - //int value = FieldAsInt(row, i); - //symbol.Set(i - offset, column.IsNullable ? nullableValue : value); - symbol.Set(i - offset, nullableValue); - break; - case Wix3.ColumnType.Unknown: - break; - } - } - } - - private static Identifier GetIdentifierForRow(Wix3.Row row) - { - var column = row.Fields[0].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); - case Wix3.ColumnType.Number: - return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); - default: - return null; - } - } - - private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) - { - switch (outputType) - { - case Wix3.OutputType.Bundle: - return SectionType.Bundle; - case Wix3.OutputType.Module: - return SectionType.Module; - case Wix3.OutputType.Patch: - return SectionType.Patch; - case Wix3.OutputType.PatchCreation: - return SectionType.PatchCreation; - case Wix3.OutputType.Product: - return SectionType.Product; - case Wix3.OutputType.Transform: - case Wix3.OutputType.Unknown: - default: - return SectionType.Unknown; - } - } - - private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) - { - return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); - } - - private static string FieldAsString(Wix3.Row row, int column) - { - return (string)row[column]; - } - - private static int FieldAsInt(Wix3.Row row, int column) - { - return Convert.ToInt32(row[column]); - } - - private static int? FieldAsNullableInt(Wix3.Row row, int column) - { - var field = row.Fields[column]; - if (field.Data == null) - { - return null; - } - else - { - return Convert.ToInt32(field.Data); - } - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : null, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : null - }; - } - } -} diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs new file mode 100644 index 00000000..ae054079 --- /dev/null +++ b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs @@ -0,0 +1,606 @@ +// 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 WixToolsetTest.Converters.Symbolizer +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Linq; + using WixBuildTools.TestSupport; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + using WixToolset.Converters.Symbolizer; + using WixToolset.Data; + using WixToolset.Data.WindowsInstaller; + using WixToolset.Data.Symbols; + using Xunit; + + public class ConvertSymbolsFixture + { + [Fact] + public void CanLoadWixoutAndConvertToIntermediate() + { + var rootFolder = TestData.Get(); + var dataFolder = TestData.Get(@"TestData\Integration"); + + using (var fs = new DisposableFileSystem()) + { + var intermediateFolder = fs.GetFolder(); + + var path = Path.Combine(dataFolder, "test.wixout"); + + var intermediate = ConvertSymbols.ConvertFile(path); + + Assert.NotNull(intermediate); + Assert.Single(intermediate.Sections); + Assert.Equal(String.Empty, intermediate.Id); + + // Save and load to guarantee round-tripping support. + // + var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); + intermediate.Save(wixiplFile); + + intermediate = Intermediate.Load(wixiplFile); + + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + + // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. + // + var tables = output.Tables.Cast(); + var wix3Dump = tables + .SelectMany(table => table.Rows.Cast() + .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) + .Where(s => !String.IsNullOrEmpty(s)) + .OrderBy(s => s) + .ToArray(); + + var symbols = intermediate.Sections.SelectMany(s => s.Symbols); + + var assemblySymbolsByFileId = symbols.OfType().ToDictionary(a => a.Id.Id); + + var wix4Dump = symbols + .SelectMany(symbol => SymbolToStrings(symbol, assemblySymbolsByFileId)) + .OrderBy(s => s) + .ToArray(); + +#if false + Assert.Equal(wix3Dump, wix4Dump); +#else // useful when you want to diff the outputs with another diff tool. + var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); + var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); + + var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); + var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); + + File.WriteAllText(path3, wix3TextDump); + File.WriteAllText(path4, wix4TextDump); + + Assert.Equal(wix3TextDump, wix4TextDump); +#endif + } + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add((int)row[0], row); + } + } + + return wixMediaByDiskId; + } + + private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) + { + string fields = null; + + // Massage output to match WiX v3 rows and v4 symbols. + // + switch (row.Table.Name) + { + case "Directory": + var dirs = SplitDefaultDir((string)row[2]); + fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); + break; + case "File": + { + var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); + if (fieldValues[3] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[3] = "0"; + } + fields = String.Join(",", fieldValues); + break; + } + case "Media": + var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; + + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); + break; + case "RegLocator": + var type = (int)row[4]; + fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); + break; + case "RemoveFile": + var attributes = (int)row[4]; + var onInstall = (attributes & 1) == 1 ? (bool?)true : null; + var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; + fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); + fields = String.Join(",", fields, onInstall, onUninstall); + break; + case "Shortcut": + var split = ((string)row[2]).Split('|'); + var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); + fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); + break; + case "WixAction": + var table = (int)SequenceStringToSequenceTable(row[0]); + fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); + break; + case "WixFile": + { + var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); + if (fieldValues[8] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[8] = "0"; + } + if (fieldValues[10] == null) + { + // WixFile rows that come from merge modules will not have the attributes column set + // so initilaize with 0. + fieldValues[10] = "0"; + } + fields = String.Join(",", fieldValues); + break; + } + case "WixMedia": + break; + default: + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + break; + } + + if (fields != null) + { + yield return $"{row.Table.Name}:{fields}"; + } + } + + private static IEnumerable SymbolToStrings(IntermediateSymbol symbol, Dictionary assemblySymbolsByFileId) + { + var name = symbol.Definition.Type == SymbolDefinitionType.SummaryInformation ? "_SummaryInformation" : symbol.Definition.Name; + var id = symbol.Id?.Id ?? String.Empty; + + string fields; + switch (symbol.Definition.Name) + { + // Massage output to match WiX v3 rows and v4 symbols. + // + case "Component": + { + var componentSymbol = (ComponentSymbol)symbol; + var attributes = ComponentLocation.Either == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; + attributes |= ComponentLocation.SourceOnly == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; + attributes |= ComponentKeyPathType.Registry == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; + attributes |= ComponentKeyPathType.OdbcDataSource == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; + attributes |= componentSymbol.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; + attributes |= componentSymbol.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; + attributes |= componentSymbol.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; + attributes |= componentSymbol.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; + attributes |= componentSymbol.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; + attributes |= componentSymbol.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; + attributes |= componentSymbol.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + attributes |= componentSymbol.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + + fields = String.Join(",", + componentSymbol.ComponentId, + componentSymbol.DirectoryRef, + attributes.ToString(), + componentSymbol.Condition, + componentSymbol.KeyPath + ); + break; + } + case "CustomAction": + { + var customActionSymbol = (CustomActionSymbol)symbol; + var type = customActionSymbol.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; + type |= customActionSymbol.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; + type |= customActionSymbol.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; + type |= customActionSymbol.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; + type |= customActionSymbol.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; + type |= customActionSymbol.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; + type |= CustomActionExecutionType.FirstSequence == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; + type |= CustomActionExecutionType.OncePerProcess == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; + type |= CustomActionExecutionType.ClientRepeat == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; + type |= CustomActionExecutionType.Deferred == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; + type |= CustomActionExecutionType.Rollback == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; + type |= CustomActionExecutionType.Commit == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; + type |= CustomActionSourceType.File == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; + type |= CustomActionSourceType.Directory == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; + type |= CustomActionSourceType.Property == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; + type |= CustomActionTargetType.Dll == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; + type |= CustomActionTargetType.Exe == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; + type |= CustomActionTargetType.TextData == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; + type |= CustomActionTargetType.JScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; + type |= CustomActionTargetType.VBScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; + + fields = String.Join(",", + type.ToString(), + customActionSymbol.Source, + customActionSymbol.Target, + customActionSymbol.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null + ); + break; + } + case "Directory": + { + var directorySymbol = (DirectorySymbol)symbol; + + if (!String.IsNullOrEmpty(directorySymbol.ComponentGuidGenerationSeed)) + { + yield return $"WixDirectory:{directorySymbol.Id.Id},{directorySymbol.ComponentGuidGenerationSeed}"; + } + + fields = String.Join(",", directorySymbol.ParentDirectoryRef, directorySymbol.Name, directorySymbol.ShortName, directorySymbol.SourceName, directorySymbol.SourceShortName); + break; + } + case "Feature": + { + var featureSymbol = (FeatureSymbol)symbol; + var attributes = featureSymbol.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; + attributes |= featureSymbol.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; + attributes |= FeatureInstallDefault.FollowParent == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; + attributes |= FeatureInstallDefault.Source == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; + attributes |= FeatureTypicalDefault.Advertise == featureSymbol.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; + + fields = String.Join(",", + featureSymbol.ParentFeatureRef, + featureSymbol.Title, + featureSymbol.Description, + featureSymbol.Display.ToString(), + featureSymbol.Level.ToString(), + featureSymbol.DirectoryRef, + attributes.ToString()); + break; + } + case "File": + { + var fileSymbol = (FileSymbol)symbol; + + if (fileSymbol.BindPath != null) + { + yield return $"BindImage:{fileSymbol.Id.Id},{fileSymbol.BindPath}"; + } + + if (fileSymbol.FontTitle != null) + { + yield return $"Font:{fileSymbol.Id.Id},{fileSymbol.FontTitle}"; + } + + if (fileSymbol.SelfRegCost.HasValue) + { + yield return $"SelfReg:{fileSymbol.Id.Id},{fileSymbol.SelfRegCost}"; + } + + int? assemblyAttributes = null; + if (assemblySymbolsByFileId.TryGetValue(fileSymbol.Id.Id, out var assemblySymbol)) + { + if (assemblySymbol.Type == AssemblyType.DotNetAssembly) + { + assemblyAttributes = 0; + } + else if (assemblySymbol.Type == AssemblyType.Win32Assembly) + { + assemblyAttributes = 1; + } + } + + yield return "WixFile:" + String.Join(",", + fileSymbol.Id.Id, + assemblyAttributes, + assemblySymbol?.ManifestFileRef, + assemblySymbol?.ApplicationFileRef, + fileSymbol.DirectoryRef, + fileSymbol.DiskId, + fileSymbol.Source.Path, + null, // assembly processor arch + fileSymbol.PatchGroup, + (fileSymbol.Attributes & FileSymbolAttributes.GeneratedShortFileName) != 0 ? 1 : 0, + (int)fileSymbol.PatchAttributes, + fileSymbol.RetainLengths, + fileSymbol.IgnoreOffsets, + fileSymbol.IgnoreLengths, + fileSymbol.RetainOffsets + ); + + var fileAttributes = 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; + + fields = String.Join(",", + fileSymbol.ComponentRef, + fileSymbol.Name, + fileSymbol.FileSize.ToString(), + fileSymbol.Version, + fileSymbol.Language, + fileAttributes); + break; + } + + case "Media": + fields = String.Join(",", symbol.Fields.Skip(1).Select(SafeConvertField)); + break; + + case "Assembly": + { + var assemblySymbol = (AssemblySymbol)symbol; + + id = null; + name = "MsiAssembly"; + fields = String.Join(",", assemblySymbol.ComponentRef, assemblySymbol.FeatureRef, assemblySymbol.ManifestFileRef, assemblySymbol.ApplicationFileRef, assemblySymbol.Type == AssemblyType.Win32Assembly ? 1 : 0); + break; + } + case "RegLocator": + { + var locatorSymbol = (RegLocatorSymbol)symbol; + + fields = String.Join(",", (int)locatorSymbol.Root, locatorSymbol.Key, locatorSymbol.Name, (int)locatorSymbol.Type, locatorSymbol.Win64); + break; + } + case "Registry": + { + var registrySymbol = (RegistrySymbol)symbol; + var value = registrySymbol.Value; + + switch (registrySymbol.ValueType) + { + case RegistryValueType.Binary: + value = String.Concat("#x", value); + break; + case RegistryValueType.Expandable: + value = String.Concat("#%", value); + break; + case RegistryValueType.Integer: + value = String.Concat("#", value); + break; + case RegistryValueType.MultiString: + switch (registrySymbol.ValueAction) + { + case RegistryValueActionType.Append: + value = String.Concat("[~]", value); + break; + case RegistryValueActionType.Prepend: + value = String.Concat(value, "[~]"); + break; + case RegistryValueActionType.Write: + default: + if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) + { + value = String.Concat("[~]", value, "[~]"); + } + break; + } + break; + case RegistryValueType.String: + // escape the leading '#' character for string registry keys + if (null != value && value.StartsWith("#", StringComparison.Ordinal)) + { + value = String.Concat("#", value); + } + break; + } + + fields = String.Join(",", + ((int)registrySymbol.Root).ToString(), + registrySymbol.Key, + registrySymbol.Name, + value, + registrySymbol.ComponentRef + ); + break; + } + + case "RemoveRegistry": + { + var removeRegistrySymbol = (RemoveRegistrySymbol)symbol; + fields = String.Join(",", + ((int)removeRegistrySymbol.Root).ToString(), + removeRegistrySymbol.Key, + removeRegistrySymbol.Name, + removeRegistrySymbol.ComponentRef + ); + break; + } + + case "ServiceControl": + { + var serviceControlSymbol = (ServiceControlSymbol)symbol; + + var events = serviceControlSymbol.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; + events |= serviceControlSymbol.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; + events |= serviceControlSymbol.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; + events |= serviceControlSymbol.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; + events |= serviceControlSymbol.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; + events |= serviceControlSymbol.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; + + fields = String.Join(",", + serviceControlSymbol.Name, + events.ToString(), + serviceControlSymbol.Arguments, + serviceControlSymbol.Wait == true ? "1" : "0", + serviceControlSymbol.ComponentRef + ); + break; + } + + case "ServiceInstall": + { + var serviceInstallSymbol = (ServiceInstallSymbol)symbol; + + var errorControl = (int)serviceInstallSymbol.ErrorControl; + errorControl |= serviceInstallSymbol.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; + + var serviceType = (int)serviceInstallSymbol.ServiceType; + serviceType |= serviceInstallSymbol.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; + + fields = String.Join(",", + serviceInstallSymbol.Name, + serviceInstallSymbol.DisplayName, + serviceType.ToString(), + ((int)serviceInstallSymbol.StartType).ToString(), + errorControl.ToString(), + serviceInstallSymbol.LoadOrderGroup, + serviceInstallSymbol.Dependencies, + serviceInstallSymbol.StartName, + serviceInstallSymbol.Password, + serviceInstallSymbol.Arguments, + serviceInstallSymbol.ComponentRef, + serviceInstallSymbol.Description + ); + break; + } + + case "Upgrade": + { + var upgradeSymbol = (UpgradeSymbol)symbol; + + var attributes = upgradeSymbol.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; + attributes |= upgradeSymbol.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; + attributes |= upgradeSymbol.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; + attributes |= upgradeSymbol.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; + attributes |= upgradeSymbol.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; + attributes |= upgradeSymbol.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; + + fields = String.Join(",", + upgradeSymbol.VersionMin, + upgradeSymbol.VersionMax, + upgradeSymbol.Language, + attributes.ToString(), + upgradeSymbol.Remove, + upgradeSymbol.ActionProperty + ); + break; + } + + case "WixAction": + { + var wixActionSymbol = (WixActionSymbol)symbol; + var data = wixActionSymbol.Fields[(int)WixActionSymbolFields.SequenceTable].AsObject(); + var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionSymbol.SequenceTable; + + fields = String.Join(",", + sequenceTableAsInt, + wixActionSymbol.Action, + wixActionSymbol.Condition, + wixActionSymbol.Sequence?.ToString() ?? String.Empty, + wixActionSymbol.Before, + wixActionSymbol.After, + wixActionSymbol.Overridable == true ? "1" : "0" + ); + break; + } + + case "WixComplexReference": + { + var wixComplexReferenceSymbol = (WixComplexReferenceSymbol)symbol; + fields = String.Join(",", + wixComplexReferenceSymbol.Parent, + (int)wixComplexReferenceSymbol.ParentType, + wixComplexReferenceSymbol.ParentLanguage, + wixComplexReferenceSymbol.Child, + (int)wixComplexReferenceSymbol.ChildType, + wixComplexReferenceSymbol.IsPrimary ? "1" : "0" + ); + break; + } + + case "WixProperty": + { + var wixPropertySymbol = (WixPropertySymbol)symbol; + var attributes = wixPropertySymbol.Admin ? 0x1 : 0; + attributes |= wixPropertySymbol.Hidden ? 0x2 : 0; + attributes |= wixPropertySymbol.Secure ? 0x4 : 0; + + fields = String.Join(",", + wixPropertySymbol.PropertyRef, + attributes.ToString() + ); + break; + } + + default: + fields = String.Join(",", symbol.Fields.Select(SafeConvertField)); + break; + } + + fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; + yield return $"{name}:{fields}"; + } + + private static SequenceTable SequenceStringToSequenceTable(object sequenceString) + { + switch (sequenceString) + { + case "AdminExecuteSequence": + return SequenceTable.AdminExecuteSequence; + case "AdminUISequence": + return SequenceTable.AdminUISequence; + case "AdvtExecuteSequence": + return SequenceTable.AdvertiseExecuteSequence; + case "InstallExecuteSequence": + return SequenceTable.InstallExecuteSequence; + case "InstallUISequence": + return SequenceTable.InstallUISequence; + default: + throw new ArgumentException($"Unknown sequence: {sequenceString}"); + } + } + + private static string SafeConvertField(Wix3.Field field) + { + return field?.Data?.ToString(); + } + + private static string SafeConvertField(IntermediateField field) + { + var data = field.AsObject(); + if (data is IntermediateFieldPathValue path) + { + return path.Path; + } + + return data?.ToString(); + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : String.Empty, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty + }; + } + } +} diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs deleted file mode 100644 index ae054079..00000000 --- a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertTuplesFixture.cs +++ /dev/null @@ -1,606 +0,0 @@ -// 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 WixToolsetTest.Converters.Symbolizer -{ - using System; - using System.Collections.Generic; - using System.IO; - using System.Linq; - using WixBuildTools.TestSupport; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - using WixToolset.Converters.Symbolizer; - using WixToolset.Data; - using WixToolset.Data.WindowsInstaller; - using WixToolset.Data.Symbols; - using Xunit; - - public class ConvertSymbolsFixture - { - [Fact] - public void CanLoadWixoutAndConvertToIntermediate() - { - var rootFolder = TestData.Get(); - var dataFolder = TestData.Get(@"TestData\Integration"); - - using (var fs = new DisposableFileSystem()) - { - var intermediateFolder = fs.GetFolder(); - - var path = Path.Combine(dataFolder, "test.wixout"); - - var intermediate = ConvertSymbols.ConvertFile(path); - - Assert.NotNull(intermediate); - Assert.Single(intermediate.Sections); - Assert.Equal(String.Empty, intermediate.Id); - - // Save and load to guarantee round-tripping support. - // - var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); - intermediate.Save(wixiplFile); - - intermediate = Intermediate.Load(wixiplFile); - - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - - // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. - // - var tables = output.Tables.Cast(); - var wix3Dump = tables - .SelectMany(table => table.Rows.Cast() - .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) - .Where(s => !String.IsNullOrEmpty(s)) - .OrderBy(s => s) - .ToArray(); - - var symbols = intermediate.Sections.SelectMany(s => s.Symbols); - - var assemblySymbolsByFileId = symbols.OfType().ToDictionary(a => a.Id.Id); - - var wix4Dump = symbols - .SelectMany(symbol => SymbolToStrings(symbol, assemblySymbolsByFileId)) - .OrderBy(s => s) - .ToArray(); - -#if false - Assert.Equal(wix3Dump, wix4Dump); -#else // useful when you want to diff the outputs with another diff tool. - var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); - var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); - - var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); - var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); - - File.WriteAllText(path3, wix3TextDump); - File.WriteAllText(path4, wix4TextDump); - - Assert.Equal(wix3TextDump, wix4TextDump); -#endif - } - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add((int)row[0], row); - } - } - - return wixMediaByDiskId; - } - - private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) - { - string fields = null; - - // Massage output to match WiX v3 rows and v4 symbols. - // - switch (row.Table.Name) - { - case "Directory": - var dirs = SplitDefaultDir((string)row[2]); - fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); - break; - case "File": - { - var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); - if (fieldValues[3] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[3] = "0"; - } - fields = String.Join(",", fieldValues); - break; - } - case "Media": - var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; - - fields = String.Join(",", row.Fields.Select(SafeConvertField)); - fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); - break; - case "RegLocator": - var type = (int)row[4]; - fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); - break; - case "RemoveFile": - var attributes = (int)row[4]; - var onInstall = (attributes & 1) == 1 ? (bool?)true : null; - var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; - fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); - fields = String.Join(",", fields, onInstall, onUninstall); - break; - case "Shortcut": - var split = ((string)row[2]).Split('|'); - var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); - fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); - break; - case "WixAction": - var table = (int)SequenceStringToSequenceTable(row[0]); - fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); - break; - case "WixFile": - { - var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); - if (fieldValues[8] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[8] = "0"; - } - if (fieldValues[10] == null) - { - // WixFile rows that come from merge modules will not have the attributes column set - // so initilaize with 0. - fieldValues[10] = "0"; - } - fields = String.Join(",", fieldValues); - break; - } - case "WixMedia": - break; - default: - fields = String.Join(",", row.Fields.Select(SafeConvertField)); - break; - } - - if (fields != null) - { - yield return $"{row.Table.Name}:{fields}"; - } - } - - private static IEnumerable SymbolToStrings(IntermediateSymbol symbol, Dictionary assemblySymbolsByFileId) - { - var name = symbol.Definition.Type == SymbolDefinitionType.SummaryInformation ? "_SummaryInformation" : symbol.Definition.Name; - var id = symbol.Id?.Id ?? String.Empty; - - string fields; - switch (symbol.Definition.Name) - { - // Massage output to match WiX v3 rows and v4 symbols. - // - case "Component": - { - var componentSymbol = (ComponentSymbol)symbol; - var attributes = ComponentLocation.Either == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; - attributes |= ComponentLocation.SourceOnly == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; - attributes |= ComponentKeyPathType.Registry == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; - attributes |= ComponentKeyPathType.OdbcDataSource == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; - attributes |= componentSymbol.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; - attributes |= componentSymbol.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; - attributes |= componentSymbol.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; - attributes |= componentSymbol.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; - attributes |= componentSymbol.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; - attributes |= componentSymbol.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; - attributes |= componentSymbol.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - attributes |= componentSymbol.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - - fields = String.Join(",", - componentSymbol.ComponentId, - componentSymbol.DirectoryRef, - attributes.ToString(), - componentSymbol.Condition, - componentSymbol.KeyPath - ); - break; - } - case "CustomAction": - { - var customActionSymbol = (CustomActionSymbol)symbol; - var type = customActionSymbol.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; - type |= customActionSymbol.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; - type |= customActionSymbol.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; - type |= customActionSymbol.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; - type |= customActionSymbol.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; - type |= customActionSymbol.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; - type |= CustomActionExecutionType.FirstSequence == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; - type |= CustomActionExecutionType.OncePerProcess == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; - type |= CustomActionExecutionType.ClientRepeat == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; - type |= CustomActionExecutionType.Deferred == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; - type |= CustomActionExecutionType.Rollback == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; - type |= CustomActionExecutionType.Commit == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; - type |= CustomActionSourceType.File == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; - type |= CustomActionSourceType.Directory == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; - type |= CustomActionSourceType.Property == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; - type |= CustomActionTargetType.Dll == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; - type |= CustomActionTargetType.Exe == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; - type |= CustomActionTargetType.TextData == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; - type |= CustomActionTargetType.JScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; - type |= CustomActionTargetType.VBScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; - - fields = String.Join(",", - type.ToString(), - customActionSymbol.Source, - customActionSymbol.Target, - customActionSymbol.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null - ); - break; - } - case "Directory": - { - var directorySymbol = (DirectorySymbol)symbol; - - if (!String.IsNullOrEmpty(directorySymbol.ComponentGuidGenerationSeed)) - { - yield return $"WixDirectory:{directorySymbol.Id.Id},{directorySymbol.ComponentGuidGenerationSeed}"; - } - - fields = String.Join(",", directorySymbol.ParentDirectoryRef, directorySymbol.Name, directorySymbol.ShortName, directorySymbol.SourceName, directorySymbol.SourceShortName); - break; - } - case "Feature": - { - var featureSymbol = (FeatureSymbol)symbol; - var attributes = featureSymbol.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; - attributes |= featureSymbol.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; - attributes |= FeatureInstallDefault.FollowParent == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; - attributes |= FeatureInstallDefault.Source == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; - attributes |= FeatureTypicalDefault.Advertise == featureSymbol.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; - - fields = String.Join(",", - featureSymbol.ParentFeatureRef, - featureSymbol.Title, - featureSymbol.Description, - featureSymbol.Display.ToString(), - featureSymbol.Level.ToString(), - featureSymbol.DirectoryRef, - attributes.ToString()); - break; - } - case "File": - { - var fileSymbol = (FileSymbol)symbol; - - if (fileSymbol.BindPath != null) - { - yield return $"BindImage:{fileSymbol.Id.Id},{fileSymbol.BindPath}"; - } - - if (fileSymbol.FontTitle != null) - { - yield return $"Font:{fileSymbol.Id.Id},{fileSymbol.FontTitle}"; - } - - if (fileSymbol.SelfRegCost.HasValue) - { - yield return $"SelfReg:{fileSymbol.Id.Id},{fileSymbol.SelfRegCost}"; - } - - int? assemblyAttributes = null; - if (assemblySymbolsByFileId.TryGetValue(fileSymbol.Id.Id, out var assemblySymbol)) - { - if (assemblySymbol.Type == AssemblyType.DotNetAssembly) - { - assemblyAttributes = 0; - } - else if (assemblySymbol.Type == AssemblyType.Win32Assembly) - { - assemblyAttributes = 1; - } - } - - yield return "WixFile:" + String.Join(",", - fileSymbol.Id.Id, - assemblyAttributes, - assemblySymbol?.ManifestFileRef, - assemblySymbol?.ApplicationFileRef, - fileSymbol.DirectoryRef, - fileSymbol.DiskId, - fileSymbol.Source.Path, - null, // assembly processor arch - fileSymbol.PatchGroup, - (fileSymbol.Attributes & FileSymbolAttributes.GeneratedShortFileName) != 0 ? 1 : 0, - (int)fileSymbol.PatchAttributes, - fileSymbol.RetainLengths, - fileSymbol.IgnoreOffsets, - fileSymbol.IgnoreLengths, - fileSymbol.RetainOffsets - ); - - var fileAttributes = 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; - - fields = String.Join(",", - fileSymbol.ComponentRef, - fileSymbol.Name, - fileSymbol.FileSize.ToString(), - fileSymbol.Version, - fileSymbol.Language, - fileAttributes); - break; - } - - case "Media": - fields = String.Join(",", symbol.Fields.Skip(1).Select(SafeConvertField)); - break; - - case "Assembly": - { - var assemblySymbol = (AssemblySymbol)symbol; - - id = null; - name = "MsiAssembly"; - fields = String.Join(",", assemblySymbol.ComponentRef, assemblySymbol.FeatureRef, assemblySymbol.ManifestFileRef, assemblySymbol.ApplicationFileRef, assemblySymbol.Type == AssemblyType.Win32Assembly ? 1 : 0); - break; - } - case "RegLocator": - { - var locatorSymbol = (RegLocatorSymbol)symbol; - - fields = String.Join(",", (int)locatorSymbol.Root, locatorSymbol.Key, locatorSymbol.Name, (int)locatorSymbol.Type, locatorSymbol.Win64); - break; - } - case "Registry": - { - var registrySymbol = (RegistrySymbol)symbol; - var value = registrySymbol.Value; - - switch (registrySymbol.ValueType) - { - case RegistryValueType.Binary: - value = String.Concat("#x", value); - break; - case RegistryValueType.Expandable: - value = String.Concat("#%", value); - break; - case RegistryValueType.Integer: - value = String.Concat("#", value); - break; - case RegistryValueType.MultiString: - switch (registrySymbol.ValueAction) - { - case RegistryValueActionType.Append: - value = String.Concat("[~]", value); - break; - case RegistryValueActionType.Prepend: - value = String.Concat(value, "[~]"); - break; - case RegistryValueActionType.Write: - default: - if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) - { - value = String.Concat("[~]", value, "[~]"); - } - break; - } - break; - case RegistryValueType.String: - // escape the leading '#' character for string registry keys - if (null != value && value.StartsWith("#", StringComparison.Ordinal)) - { - value = String.Concat("#", value); - } - break; - } - - fields = String.Join(",", - ((int)registrySymbol.Root).ToString(), - registrySymbol.Key, - registrySymbol.Name, - value, - registrySymbol.ComponentRef - ); - break; - } - - case "RemoveRegistry": - { - var removeRegistrySymbol = (RemoveRegistrySymbol)symbol; - fields = String.Join(",", - ((int)removeRegistrySymbol.Root).ToString(), - removeRegistrySymbol.Key, - removeRegistrySymbol.Name, - removeRegistrySymbol.ComponentRef - ); - break; - } - - case "ServiceControl": - { - var serviceControlSymbol = (ServiceControlSymbol)symbol; - - var events = serviceControlSymbol.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; - events |= serviceControlSymbol.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; - events |= serviceControlSymbol.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; - events |= serviceControlSymbol.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; - events |= serviceControlSymbol.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; - events |= serviceControlSymbol.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; - - fields = String.Join(",", - serviceControlSymbol.Name, - events.ToString(), - serviceControlSymbol.Arguments, - serviceControlSymbol.Wait == true ? "1" : "0", - serviceControlSymbol.ComponentRef - ); - break; - } - - case "ServiceInstall": - { - var serviceInstallSymbol = (ServiceInstallSymbol)symbol; - - var errorControl = (int)serviceInstallSymbol.ErrorControl; - errorControl |= serviceInstallSymbol.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; - - var serviceType = (int)serviceInstallSymbol.ServiceType; - serviceType |= serviceInstallSymbol.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; - - fields = String.Join(",", - serviceInstallSymbol.Name, - serviceInstallSymbol.DisplayName, - serviceType.ToString(), - ((int)serviceInstallSymbol.StartType).ToString(), - errorControl.ToString(), - serviceInstallSymbol.LoadOrderGroup, - serviceInstallSymbol.Dependencies, - serviceInstallSymbol.StartName, - serviceInstallSymbol.Password, - serviceInstallSymbol.Arguments, - serviceInstallSymbol.ComponentRef, - serviceInstallSymbol.Description - ); - break; - } - - case "Upgrade": - { - var upgradeSymbol = (UpgradeSymbol)symbol; - - var attributes = upgradeSymbol.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; - attributes |= upgradeSymbol.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; - attributes |= upgradeSymbol.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; - attributes |= upgradeSymbol.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; - attributes |= upgradeSymbol.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; - attributes |= upgradeSymbol.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; - - fields = String.Join(",", - upgradeSymbol.VersionMin, - upgradeSymbol.VersionMax, - upgradeSymbol.Language, - attributes.ToString(), - upgradeSymbol.Remove, - upgradeSymbol.ActionProperty - ); - break; - } - - case "WixAction": - { - var wixActionSymbol = (WixActionSymbol)symbol; - var data = wixActionSymbol.Fields[(int)WixActionSymbolFields.SequenceTable].AsObject(); - var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionSymbol.SequenceTable; - - fields = String.Join(",", - sequenceTableAsInt, - wixActionSymbol.Action, - wixActionSymbol.Condition, - wixActionSymbol.Sequence?.ToString() ?? String.Empty, - wixActionSymbol.Before, - wixActionSymbol.After, - wixActionSymbol.Overridable == true ? "1" : "0" - ); - break; - } - - case "WixComplexReference": - { - var wixComplexReferenceSymbol = (WixComplexReferenceSymbol)symbol; - fields = String.Join(",", - wixComplexReferenceSymbol.Parent, - (int)wixComplexReferenceSymbol.ParentType, - wixComplexReferenceSymbol.ParentLanguage, - wixComplexReferenceSymbol.Child, - (int)wixComplexReferenceSymbol.ChildType, - wixComplexReferenceSymbol.IsPrimary ? "1" : "0" - ); - break; - } - - case "WixProperty": - { - var wixPropertySymbol = (WixPropertySymbol)symbol; - var attributes = wixPropertySymbol.Admin ? 0x1 : 0; - attributes |= wixPropertySymbol.Hidden ? 0x2 : 0; - attributes |= wixPropertySymbol.Secure ? 0x4 : 0; - - fields = String.Join(",", - wixPropertySymbol.PropertyRef, - attributes.ToString() - ); - break; - } - - default: - fields = String.Join(",", symbol.Fields.Select(SafeConvertField)); - break; - } - - fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; - yield return $"{name}:{fields}"; - } - - private static SequenceTable SequenceStringToSequenceTable(object sequenceString) - { - switch (sequenceString) - { - case "AdminExecuteSequence": - return SequenceTable.AdminExecuteSequence; - case "AdminUISequence": - return SequenceTable.AdminUISequence; - case "AdvtExecuteSequence": - return SequenceTable.AdvertiseExecuteSequence; - case "InstallExecuteSequence": - return SequenceTable.InstallExecuteSequence; - case "InstallUISequence": - return SequenceTable.InstallUISequence; - default: - throw new ArgumentException($"Unknown sequence: {sequenceString}"); - } - } - - private static string SafeConvertField(Wix3.Field field) - { - return field?.Data?.ToString(); - } - - private static string SafeConvertField(IntermediateField field) - { - var data = field.AsObject(); - if (data is IntermediateFieldPathValue path) - { - return path.Path; - } - - return data?.ToString(); - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : String.Empty, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty - }; - } - } -} -- cgit v1.2.3-55-g6feb From 0eec58b87b3aeb73758f8bb581244e291631d767 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 26 Jun 2020 13:52:38 -0700 Subject: Skip v3 conversions when re-converting v4 code Rename Wix3Converter to WixConverter as the class is used for all conversions. --- src/WixToolset.Converters/ConvertCommand.cs | 4 +- src/WixToolset.Converters/Wix3Converter.cs | 1073 ------------------- src/WixToolset.Converters/WixConverter.cs | 1098 ++++++++++++++++++++ .../WixToolsetTest.Converters/ConditionFixture.cs | 10 +- .../WixToolsetTest.Converters/ConverterFixture.cs | 28 +- .../ConverterIntegrationFixture.cs | 6 +- .../CustomActionFixture.cs | 4 +- .../CustomTableFixture.cs | 10 +- .../WixToolsetTest.Converters/PropertyFixture.cs | 6 +- .../WixToolsetTest.Converters/SequenceFixture.cs | 2 +- 10 files changed, 1133 insertions(+), 1108 deletions(-) delete mode 100644 src/WixToolset.Converters/Wix3Converter.cs create mode 100644 src/WixToolset.Converters/WixConverter.cs (limited to 'src') diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs index 139b5813..51e7b997 100644 --- a/src/WixToolset.Converters/ConvertCommand.cs +++ b/src/WixToolset.Converters/ConvertCommand.cs @@ -133,7 +133,7 @@ namespace WixToolset.Converters } } - var converter = new Wix3Converter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); + var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); var errors = this.InspectSubDirectories(converter, Path.GetFullPath("."), cancellationToken); @@ -204,7 +204,7 @@ namespace WixToolset.Converters /// /// The directory whose sub-directories will be inspected. /// The number of errors that were found. - private int InspectSubDirectories(Wix3Converter converter, string directory, CancellationToken cancellationToken) + private int InspectSubDirectories(WixConverter converter, string directory, CancellationToken cancellationToken) { var errors = 0; diff --git a/src/WixToolset.Converters/Wix3Converter.cs b/src/WixToolset.Converters/Wix3Converter.cs deleted file mode 100644 index 8c7d2049..00000000 --- a/src/WixToolset.Converters/Wix3Converter.cs +++ /dev/null @@ -1,1073 +0,0 @@ -// 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.Converters -{ - using System; - using System.Collections.Generic; - using System.Globalization; - using System.IO; - using System.Linq; - using System.Text; - using System.Text.RegularExpressions; - using System.Xml; - using System.Xml.Linq; - using WixToolset.Data; - using WixToolset.Extensibility.Services; - - /// - /// WiX source code converter. - /// - public class Wix3Converter - { - private static readonly Regex AddPrefix = new Regex(@"^[^a-zA-Z_]", RegexOptions.Compiled); - private static readonly Regex IllegalIdentifierCharacters = new Regex(@"[^A-Za-z0-9_\.]|\.{2,}", RegexOptions.Compiled); // non 'words' and assorted valid characters - - private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". - private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; - private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; - - private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; - private static readonly XName AdminUISequenceSequenceElementName = WixNamespace + "AdminUISequence"; - private static readonly XName AdvertiseExecuteSequenceElementName = WixNamespace + "AdvertiseExecuteSequence"; - private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; - private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; - private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; - private static readonly XName ColumnElementName = WixNamespace + "Column"; - private static readonly XName ComponentElementName = WixNamespace + "Component"; - private static readonly XName ControlElementName = WixNamespace + "Control"; - private static readonly XName ConditionElementName = WixNamespace + "Condition"; - private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; - private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; - private static readonly XName DirectoryElementName = WixNamespace + "Directory"; - private static readonly XName FeatureElementName = WixNamespace + "Feature"; - private static readonly XName FileElementName = WixNamespace + "File"; - private static readonly XName FragmentElementName = WixNamespace + "Fragment"; - private static readonly XName ErrorElementName = WixNamespace + "Error"; - private static readonly XName LaunchElementName = WixNamespace + "Launch"; - private static readonly XName LevelElementName = WixNamespace + "Level"; - private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; - private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; - private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; - private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; - private static readonly XName PayloadElementName = WixNamespace + "Payload"; - private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; - private static readonly XName ProductElementName = WixNamespace + "Product"; - private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; - private static readonly XName PublishElementName = WixNamespace + "Publish"; - private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; - private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; - private static readonly XName RowElementName = WixNamespace + "Row"; - private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; - private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; - private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; - private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; - private static readonly XName TextElementName = WixNamespace + "Text"; - private static readonly XName UITextElementName = WixNamespace + "UIText"; - private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; - private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; - private static readonly XName PropertyElementName = WixNamespace + "Property"; - private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; - private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; - - private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() - { - { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, - { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, - { "http://schemas.microsoft.com/wix/DependencyExtension", "http://wixtoolset.org/schemas/v4/wxs/dependency" }, - { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, - { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, - { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, - { "http://schemas.microsoft.com/wix/IIsExtension", "http://wixtoolset.org/schemas/v4/wxs/iis" }, - { "http://schemas.microsoft.com/wix/MsmqExtension", "http://wixtoolset.org/schemas/v4/wxs/msmq" }, - { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, - { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, - { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, - { "http://schemas.microsoft.com/wix/TagExtension", "http://wixtoolset.org/schemas/v4/wxs/tag" }, - { "http://schemas.microsoft.com/wix/UtilExtension", WixUtilNamespace }, - { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, - { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, - { "http://schemas.microsoft.com/wix/2009/Lux", "http://wixtoolset.org/schemas/v4/lux" }, - { "http://schemas.microsoft.com/wix/2006/wi", "http://wixtoolset.org/schemas/v4/wxs" }, - { "http://schemas.microsoft.com/wix/2006/localization", "http://wixtoolset.org/schemas/v4/wxl" }, - { "http://schemas.microsoft.com/wix/2006/libraries", "http://wixtoolset.org/schemas/v4/wixlib" }, - { "http://schemas.microsoft.com/wix/2006/objects", "http://wixtoolset.org/schemas/v4/wixobj" }, - { "http://schemas.microsoft.com/wix/2006/outputs", "http://wixtoolset.org/schemas/v4/wixout" }, - { "http://schemas.microsoft.com/wix/2007/pdbs", "http://wixtoolset.org/schemas/v4/wixpdb" }, - { "http://schemas.microsoft.com/wix/2003/04/actions", "http://wixtoolset.org/schemas/v4/wi/actions" }, - { "http://schemas.microsoft.com/wix/2006/tables", "http://wixtoolset.org/schemas/v4/wi/tables" }, - { "http://schemas.microsoft.com/wix/2006/WixUnit", "http://wixtoolset.org/schemas/v4/wixunit" }, - }; - - private readonly Dictionary> ConvertElementMapping; - - /// - /// Instantiate a new Converter class. - /// - /// Indentation value to use when validating leading whitespace. - /// Test errors to display as warnings. - /// Test errors to ignore. - public Wix3Converter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null) - { - this.ConvertElementMapping = new Dictionary> - { - { Wix3Converter.AdminExecuteSequenceElementName, this.ConvertSequenceElement }, - { Wix3Converter.AdminUISequenceSequenceElementName, this.ConvertSequenceElement }, - { Wix3Converter.AdvertiseExecuteSequenceElementName, this.ConvertSequenceElement }, - { Wix3Converter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, - { Wix3Converter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, - { Wix3Converter.ColumnElementName, this.ConvertColumnElement }, - { Wix3Converter.CustomTableElementName, this.ConvertCustomTableElement }, - { Wix3Converter.ControlElementName, this.ConvertControlElement }, - { Wix3Converter.ComponentElementName, this.ConvertComponentElement }, - { Wix3Converter.DirectoryElementName, this.ConvertDirectoryElement }, - { Wix3Converter.FeatureElementName, this.ConvertFeatureElement }, - { Wix3Converter.FileElementName, this.ConvertFileElement }, - { Wix3Converter.FragmentElementName, this.ConvertFragmentElement }, - { Wix3Converter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, - { Wix3Converter.ErrorElementName, this.ConvertErrorElement }, - { Wix3Converter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, - { Wix3Converter.MsiPackageElementName, this.ConvertSuppressSignatureValidation }, - { Wix3Converter.MspPackageElementName, this.ConvertSuppressSignatureValidation }, - { Wix3Converter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, - { Wix3Converter.PayloadElementName, this.ConvertSuppressSignatureValidation }, - { Wix3Converter.PermissionExElementName, this.ConvertPermissionExElement }, - { Wix3Converter.ProductElementName, this.ConvertProductElement }, - { Wix3Converter.ProgressTextElementName, this.ConvertProgressTextElement }, - { Wix3Converter.PublishElementName, this.ConvertPublishElement }, - { Wix3Converter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, - { Wix3Converter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, - { Wix3Converter.RowElementName, this.ConvertRowElement }, - { Wix3Converter.CustomActionElementName, this.ConvertCustomActionElement }, - { Wix3Converter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, - { Wix3Converter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, - { Wix3Converter.SetPropertyElementName, this.ConvertSetPropertyElement }, - { Wix3Converter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, - { Wix3Converter.TextElementName, this.ConvertTextElement }, - { Wix3Converter.UITextElementName, this.ConvertUITextElement }, - { Wix3Converter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, - { Wix3Converter.PropertyElementName, this.ConvertPropertyElement }, - { Wix3Converter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, - { Wix3Converter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, - }; - - this.Messaging = messaging; - - this.IndentationAmount = indentationAmount; - - this.ErrorsAsWarnings = new HashSet(this.YieldConverterTypes(errorsAsWarnings)); - - this.IgnoreErrors = new HashSet(this.YieldConverterTypes(ignoreErrors)); - } - - private int Errors { get; set; } - - private HashSet ErrorsAsWarnings { get; set; } - - private HashSet IgnoreErrors { get; set; } - - private IMessaging Messaging { get; } - - private int IndentationAmount { get; set; } - - private string SourceFile { get; set; } - - /// - /// Convert a file. - /// - /// The file to convert. - /// Option to save the converted errors that are found. - /// The number of errors found. - public int ConvertFile(string sourceFile, bool saveConvertedFile) - { - XDocument document; - - // Set the instance info. - this.Errors = 0; - this.SourceFile = sourceFile; - - try - { - document = XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - } - catch (XmlException e) - { - this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); - - return this.Errors; - } - - this.ConvertDocument(document); - - // Fix errors if requested and necessary. - if (saveConvertedFile && 0 < this.Errors) - { - try - { - using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = true })) - { - document.Save(writer); - } - } - catch (UnauthorizedAccessException) - { - this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); - } - } - - return this.Errors; - } - - /// - /// Convert a document. - /// - /// The document to convert. - /// The number of errors found. - public int ConvertDocument(XDocument document) - { - this.Errors = 0; - - var declaration = document.Declaration; - - // Remove the declaration. - if (null != declaration) - { - if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) - { - document.Declaration = null; - } - } - - TrimLeadingText(document); - - // Start converting the nodes at the top. - this.ConvertNodes(document.Nodes(), 0); - - return this.Errors; - } - - private void ConvertNodes(IEnumerable nodes, int level) - { - // Note we operate on a copy of the node list since we may - // remove some whitespace nodes during this processing. - foreach (var node in nodes.ToList()) - { - if (node is XText text) - { - if (!String.IsNullOrWhiteSpace(text.Value)) - { - text.Value = text.Value.Trim(); - } - else if (node.NextNode is XCData cdata) - { - this.EnsurePrecedingWhitespaceRemoved(text, node, ConverterTestType.WhitespacePrecedingNodeWrong); - } - else if (node.NextNode is XElement element) - { - this.EnsurePrecedingWhitespaceCorrect(text, node, level, ConverterTestType.WhitespacePrecedingNodeWrong); - } - else if (node.NextNode is null) // this is the space before the close element - { - if (node.PreviousNode is null || node.PreviousNode is XCData) - { - this.EnsurePrecedingWhitespaceRemoved(text, node.Parent, ConverterTestType.WhitespacePrecedingEndElementWrong); - } - else if (level == 0) // root element's close tag - { - this.EnsurePrecedingWhitespaceCorrect(text, node, 0, ConverterTestType.WhitespacePrecedingEndElementWrong); - } - else - { - this.EnsurePrecedingWhitespaceCorrect(text, node, level - 1, ConverterTestType.WhitespacePrecedingEndElementWrong); - } - } - } - else if (node is XElement element) - { - this.ConvertElement(element); - - this.ConvertNodes(element.Nodes(), level + 1); - } - } - } - - private void EnsurePrecedingWhitespaceCorrect(XText whitespace, XNode node, int level, ConverterTestType testType) - { - if (!Wix3Converter.LeadingWhitespaceValid(this.IndentationAmount, level, whitespace.Value)) - { - var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; - - if (this.OnError(testType, node, message)) - { - Wix3Converter.FixupWhitespace(this.IndentationAmount, level, whitespace); - } - } - } - - private void EnsurePrecedingWhitespaceRemoved(XText whitespace, XNode node, ConverterTestType testType) - { - if (!String.IsNullOrEmpty(whitespace.Value) && whitespace.NodeType != XmlNodeType.CDATA) - { - var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; - - if (this.OnError(testType, node, message)) - { - whitespace.Remove(); - } - } - } - - private void ConvertElement(XElement element) - { - // Gather any deprecated namespaces, then update this element tree based on those deprecations. - var deprecatedToUpdatedNamespaces = new Dictionary(); - - foreach (var declaration in element.Attributes().Where(a => a.IsNamespaceDeclaration)) - { - if (Wix3Converter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) - { - if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) - { - deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); - } - } - } - - if (deprecatedToUpdatedNamespaces.Any()) - { - Wix3Converter.UpdateElementsWithDeprecatedNamespaces(element.DescendantsAndSelf(), deprecatedToUpdatedNamespaces); - } - - // Apply any specialized conversion actions. - if (this.ConvertElementMapping.TryGetValue(element.Name, out var convert)) - { - convert(element); - } - } - - private void ConvertColumnElement(XElement element) - { - var category = element.Attribute("Category"); - if (category != null) - { - var camelCaseValue = LowercaseFirstChar(category.Value); - if (category.Value != camelCaseValue && - this.OnError(ConverterTestType.ColumnCategoryCamelCase, element, "The CustomTable Category attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", category.Name)) - { - category.Value = camelCaseValue; - } - } - - var modularization = element.Attribute("Modularize"); - if (modularization != null) - { - var camelCaseValue = LowercaseFirstChar(modularization.Value); - if (category.Value != camelCaseValue && - this.OnError(ConverterTestType.ColumnModularizeCamelCase, element, "The CustomTable Modularize attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", modularization.Name)) - { - modularization.Value = camelCaseValue; - } - } - } - - private void ConvertCustomTableElement(XElement element) - { - var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); - if (bootstrapperApplicationData != null - && this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) - { - element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); - bootstrapperApplicationData.Remove(); - } - } - - private void ConvertControlElement(XElement element) - { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - var action = UppercaseFirstChar(xCondition.Attribute("Action")?.Value); - if (!String.IsNullOrEmpty(action) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}Condition' attribute instead.", xCondition.Name.LocalName, action)) - { - element.Add(new XAttribute(action + "Condition", text)); - xCondition.Remove(); - } - } - } - - private void ConvertComponentElement(XElement element) - { - var guid = element.Attribute("Guid"); - if (guid != null && guid.Value == "*") - { - if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Component Guid attribute is unnecessary. Remove the attribute to remove the redundancy.")) - { - guid.Remove(); - } - } - - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - if (TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) - { - element.Add(new XAttribute("Condition", text)); - xCondition.Remove(); - } - } - } - - private void ConvertDirectoryElement(XElement element) - { - if (null == element.Attribute("Name")) - { - var attribute = element.Attribute("ShortName"); - if (null != attribute) - { - var shortName = attribute.Value; - if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) - { - element.Add(new XAttribute("Name", shortName)); - attribute.Remove(); - } - } - } - } - - private void ConvertFeatureElement(XElement element) - { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - var level = xCondition.Attribute("Level")?.Value; - if (!String.IsNullOrEmpty(level) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Level' element instead.", xCondition.Name.LocalName)) - { - xCondition.AddAfterSelf(new XElement(LevelElementName, - new XAttribute("Value", level), - new XAttribute("Condition", text) - )); - xCondition.Remove(); - } - } - } - - private void ConvertFileElement(XElement element) - { - if (null == element.Attribute("Id")) - { - var attribute = element.Attribute("Name"); - - if (null == attribute) - { - attribute = element.Attribute("Source"); - } - - if (null != attribute) - { - var name = Path.GetFileName(attribute.Value); - - if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the default", name)) - { - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - element.Add(new XAttribute("Id", GetIdentifierFromName(name))); - element.Add(attributes); - } - } - } - } - - private void ConvertFragmentElement(XElement element) - { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - var message = xCondition.Attribute("Message")?.Value; - - if (!String.IsNullOrEmpty(message) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) - { - xCondition.AddAfterSelf(new XElement(LaunchElementName, - new XAttribute("Condition", text), - new XAttribute("Message", message) - )); - xCondition.Remove(); - } - } - } - - private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); - - private void ConvertPermissionExElement(XElement element) - { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - if (TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) - { - element.Add(new XAttribute("Condition", text)); - xCondition.Remove(); - } - } - } - - private void ConvertProgressTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); - - private void ConvertProductElement(XElement element) - { - var id = element.Attribute("Id"); - if (id != null && id.Value == "*") - { - if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Product Id attribute is unnecessary. Remove the attribute to remove the redundancy.")) - { - id.Remove(); - } - } - - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - var message = element.Attribute("Message")?.Value; - - if (!String.IsNullOrEmpty(message) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) - { - xCondition.AddAfterSelf(new XElement(LaunchElementName, - new XAttribute("Condition", text), - new XAttribute("Message", message) - )); - xCondition.Remove(); - } - } - } - - private void ConvertPublishElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); - - private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertSequenceElement(XElement element) - { - foreach (var child in element.Elements()) - { - this.ConvertInnerTextToAttribute(child, "Condition"); - } - } - - private void ConvertServiceArgumentElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertSetDirectoryElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertSetPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertSuppressSignatureValidation(XElement element) - { - var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); - - if (null != suppressSignatureValidation) - { - if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation.Name)) - { - if ("no" == suppressSignatureValidation.Value) - { - element.Add(new XAttribute("EnableSignatureValidation", "yes")); - } - } - - suppressSignatureValidation.Remove(); - } - } - - private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertCustomActionElement(XElement xCustomAction) - { - var xBinaryKey = xCustomAction.Attribute("BinaryKey"); - - if (xBinaryKey?.Value == "WixCA" || xBinaryKey?.Value == "UtilCA") - { - if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X86' instead.")) - { - xBinaryKey.Value = "Wix4UtilCA_X86"; - } - } - - if (xBinaryKey?.Value == "WixCA_x64" || xBinaryKey?.Value == "UtilCA_x64") - { - if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA_x64 custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X64' instead.")) - { - xBinaryKey.Value = "Wix4UtilCA_X64"; - } - } - - var xDllEntry = xCustomAction.Attribute("DllEntry"); - - if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") - { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) - { - xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); - } - } - - var xProperty = xCustomAction.Attribute("Property"); - - if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") - { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) - { - xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); - } - } - - var xScript = xCustomAction.Attribute("Script"); - - if (xScript != null && TryGetInnerText(xCustomAction, out var scriptText)) - { - if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptFile' attribute to reference it.", xCustomAction.Name.LocalName)) - { - var scriptFolder = Path.GetDirectoryName(this.SourceFile) ?? String.Empty; - var id = xCustomAction.Attribute("Id")?.Value ?? Guid.NewGuid().ToString("N"); - var ext = (xScript.Value == "jscript") ? ".js" : (xScript.Value == "vbscript") ? ".vbs" : ".txt"; - - var scriptFile = Path.Combine(scriptFolder, id + ext); - File.WriteAllText(scriptFile, scriptText); - - RemoveChildren(xCustomAction); - xCustomAction.Add(new XAttribute("ScriptFile", scriptFile)); - } - } - } - - private void ConvertPropertyElement(XElement xProperty) - { - var xId = xProperty.Attribute("Id"); - - if (xId.Value == "QtExecCmdTimeout") - { - this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); - } - - this.ConvertInnerTextToAttribute(xProperty, "Value"); - } - - private void ConvertUtilPermissionExElement(XElement element) - { - if (null == element.Attribute("Inheritable")) - { - var inheritable = element.Parent.Name == CreateFolderElementName; - if (!inheritable) - { - if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default")) - { - element.Add(new XAttribute("Inheritable", "no")); - } - } - } - } - - /// - /// Converts a Wix element. - /// - /// The Wix element to convert. - /// The converted element. - private void ConvertElementWithoutNamespace(XElement element) - { - if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) - { - element.Name = WixNamespace.GetName(element.Name.LocalName); - - element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. - - foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) - { - elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); - } - } - } - - private void ConvertInnerTextToAttribute(XElement element, string attributeName) - { - if (TryGetInnerText(element, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}' attribute instead.", element.Name.LocalName, attributeName)) - { - element.Add(new XAttribute(attributeName, text)); - RemoveChildren(element); - } - } - - private IEnumerable YieldConverterTypes(IEnumerable types) - { - if (null != types) - { - foreach (var type in types) - { - if (Enum.TryParse(type, true, out var itt)) - { - yield return itt; - } - else // not a known ConverterTestType - { - this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); - } - } - } - } - - private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) - { - foreach (var element in elements) - { - - if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) - { - element.Name = ns.GetName(element.Name.LocalName); - } - - // Remove all the attributes and add them back to with their namespace updated (as necessary). - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - - foreach (var attribute in attributes) - { - var convertedAttribute = attribute; - - if (attribute.IsNamespaceDeclaration) - { - if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) - { - convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); - } - } - else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) - { - convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); - } - - element.Add(convertedAttribute); - } - } - } - - /// - /// Determine if the whitespace preceding a node is appropriate for its depth level. - /// - /// Indentation value to use when validating leading whitespace. - /// The depth level that should match this whitespace. - /// The whitespace to validate. - /// true if the whitespace is legal; false otherwise. - private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) - { - // Strip off leading newlines; there can be an arbitrary number of these. - whitespace = whitespace.TrimStart(XDocumentNewLine); - - var indentation = new string(' ', level * indentationAmount); - - return whitespace == indentation; - } - - /// - /// Fix the whitespace in a whitespace node. - /// - /// Indentation value to use when validating leading whitespace. - /// The depth level of the desired whitespace. - /// The whitespace node to fix. - private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) - { - var value = new StringBuilder(whitespace.Value.Length); - - // Keep any previous preceeding new lines. - var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); - - // Ensure there is always at least one new line before the indentation. - value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); - - whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); - } - - /// - /// Output an error message to the console. - /// - /// The type of converter test. - /// The node that caused the error. - /// Detailed error message. - /// Additional formatted string arguments. - /// Returns true indicating that action should be taken on this error, and false if it should be ignored. - private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) - { - if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error - { - return false; - } - - // Increase the error count. - this.Errors++; - - var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); - var warning = this.ErrorsAsWarnings.Contains(converterTestType); - var display = String.Format(CultureInfo.CurrentCulture, message, args); - - var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); - - this.Messaging.Write(msg); - - return true; - } - - /// - /// Return an identifier based on passed file/directory name - /// - /// File/directory name to generate identifer from - /// A version of the name that is a legal identifier. - /// This is duplicated from WiX's Common class. - private static string GetIdentifierFromName(string name) - { - var result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". - - // MSI identifiers must begin with an alphabetic character or an - // underscore. Prefix all other values with an underscore. - if (AddPrefix.IsMatch(name)) - { - result = String.Concat("_", result); - } - - return result; - } - - private static string LowercaseFirstChar(string value) - { - if (!String.IsNullOrEmpty(value)) - { - var c = Char.ToLowerInvariant(value[0]); - if (c != value[0]) - { - var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; - return c + remainder; - } - } - - return value; - } - - private static string UppercaseFirstChar(string value) - { - if (!String.IsNullOrEmpty(value)) - { - var c = Char.ToUpperInvariant(value[0]); - if (c != value[0]) - { - var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; - return c + remainder; - } - } - - return value; - } - - private static bool TryGetInnerText(XElement element, out string value) - { - value = null; - - var nodes = element.Nodes(); - - if (nodes.All(e => e.NodeType == XmlNodeType.Text || e.NodeType == XmlNodeType.CDATA)) - { - value = String.Join(String.Empty, nodes.Cast().Select(TrimTextValue)); - } - - return !String.IsNullOrEmpty(value); - } - - private static bool IsTextNode(XNode node, out XText text) - { - text = null; - - if (node.NodeType == XmlNodeType.Text || node.NodeType == XmlNodeType.CDATA) - { - text = (XText)node; - } - - return text != null; - } - - private static void TrimLeadingText(XDocument document) - { - while (IsTextNode(document.Nodes().FirstOrDefault(), out var text)) - { - text.Remove(); - } - } - - private static string TrimTextValue(XText text) - { - var value = text.Value; - - if (String.IsNullOrEmpty(value)) - { - return String.Empty; - } - else if (text.NodeType == XmlNodeType.CDATA && String.IsNullOrWhiteSpace(value)) - { - return " "; - } - - return value.Trim(); - } - - private static void RemoveChildren(XElement element) - { - var nodes = element.Nodes().ToList(); - foreach (var node in nodes) - { - node.Remove(); - } - } - - /// - /// Converter test types. These are used to condition error messages down to warnings. - /// - private enum ConverterTestType - { - /// - /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. - /// - ConverterTestTypeUnknown, - - /// - /// Displayed when an XML loading exception has occurred. - /// - XmlException, - - /// - /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. - /// - UnauthorizedAccessException, - - /// - /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. - /// - DeclarationEncodingWrong, - - /// - /// Displayed when the XML declaration is missing from the source file. - /// - DeclarationMissing, - - /// - /// Displayed when the whitespace preceding a CDATA node is wrong. - /// - WhitespacePrecedingCDATAWrong, - - /// - /// Displayed when the whitespace preceding a node is wrong. - /// - WhitespacePrecedingNodeWrong, - - /// - /// Displayed when an element is not empty as it should be. - /// - NotEmptyElement, - - /// - /// Displayed when the whitespace following a CDATA node is wrong. - /// - WhitespaceFollowingCDATAWrong, - - /// - /// Displayed when the whitespace preceding an end element is wrong. - /// - WhitespacePrecedingEndElementWrong, - - /// - /// Displayed when the xmlns attribute is missing from the document element. - /// - XmlnsMissing, - - /// - /// Displayed when the xmlns attribute on the document element is wrong. - /// - XmlnsValueWrong, - - /// - /// Assign an identifier to a File element when on Id attribute is specified. - /// - AssignAnonymousFileId, - - /// - /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. - /// - SuppressSignatureValidationDeprecated, - - /// - /// WixCA Binary/@Id has been renamed to UtilCA. - /// - WixCABinaryIdRenamed, - - /// - /// QtExec custom actions have been renamed. - /// - QuietExecCustomActionsRenamed, - - /// - /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. - /// - QtExecCmdTimeoutAmbiguous, - - /// - /// Directory/@ShortName may only be specified with Directory/@Name. - /// - AssignDirectoryNameFromShortName, - - /// - /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. - /// - BootstrapperApplicationDataDeprecated, - - /// - /// Inheritable is new and is now defaulted to 'yes' which is a change in behavior for all but children of CreateFolder. - /// - AssignPermissionExInheritable, - - /// - /// Column element's Category attribute is camel-case. - /// - ColumnCategoryCamelCase, - - /// - /// Column element's Modularize attribute is camel-case. - /// - ColumnModularizeCamelCase, - - /// - /// Inner text value should move to an attribute. - /// - InnerTextDeprecated, - - /// - /// Explicit auto-GUID unnecessary. - /// - AutoGuidUnnecessary, - - /// - /// Displayed when the XML declaration is present in the source file. - /// - DeclarationPresent, - } - } -} diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs new file mode 100644 index 00000000..a89d44ce --- /dev/null +++ b/src/WixToolset.Converters/WixConverter.cs @@ -0,0 +1,1098 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using System.Globalization; + using System.IO; + using System.Linq; + using System.Text; + using System.Text.RegularExpressions; + using System.Xml; + using System.Xml.Linq; + using WixToolset.Data; + using WixToolset.Extensibility.Services; + + /// + /// WiX source code converter. + /// + public class WixConverter + { + private static readonly Regex AddPrefix = new Regex(@"^[^a-zA-Z_]", RegexOptions.Compiled); + private static readonly Regex IllegalIdentifierCharacters = new Regex(@"[^A-Za-z0-9_\.]|\.{2,}", RegexOptions.Compiled); // non 'words' and assorted valid characters + + private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". + private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; + private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; + + private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; + private static readonly XName AdminUISequenceSequenceElementName = WixNamespace + "AdminUISequence"; + private static readonly XName AdvertiseExecuteSequenceElementName = WixNamespace + "AdvertiseExecuteSequence"; + private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; + private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; + private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; + private static readonly XName ColumnElementName = WixNamespace + "Column"; + private static readonly XName ComponentElementName = WixNamespace + "Component"; + private static readonly XName ControlElementName = WixNamespace + "Control"; + private static readonly XName ConditionElementName = WixNamespace + "Condition"; + private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; + private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; + private static readonly XName DirectoryElementName = WixNamespace + "Directory"; + private static readonly XName FeatureElementName = WixNamespace + "Feature"; + private static readonly XName FileElementName = WixNamespace + "File"; + private static readonly XName FragmentElementName = WixNamespace + "Fragment"; + private static readonly XName ErrorElementName = WixNamespace + "Error"; + private static readonly XName LaunchElementName = WixNamespace + "Launch"; + private static readonly XName LevelElementName = WixNamespace + "Level"; + private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; + private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; + private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; + private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; + private static readonly XName PayloadElementName = WixNamespace + "Payload"; + private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; + private static readonly XName ProductElementName = WixNamespace + "Product"; + private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; + private static readonly XName PublishElementName = WixNamespace + "Publish"; + private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; + private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; + private static readonly XName RowElementName = WixNamespace + "Row"; + private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; + private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; + private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; + private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; + private static readonly XName TextElementName = WixNamespace + "Text"; + private static readonly XName UITextElementName = WixNamespace + "UIText"; + private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; + private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; + private static readonly XName PropertyElementName = WixNamespace + "Property"; + private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; + private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; + + private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() + { + { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, + { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, + { "http://schemas.microsoft.com/wix/DependencyExtension", "http://wixtoolset.org/schemas/v4/wxs/dependency" }, + { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, + { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, + { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, + { "http://schemas.microsoft.com/wix/IIsExtension", "http://wixtoolset.org/schemas/v4/wxs/iis" }, + { "http://schemas.microsoft.com/wix/MsmqExtension", "http://wixtoolset.org/schemas/v4/wxs/msmq" }, + { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, + { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, + { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, + { "http://schemas.microsoft.com/wix/TagExtension", "http://wixtoolset.org/schemas/v4/wxs/tag" }, + { "http://schemas.microsoft.com/wix/UtilExtension", WixUtilNamespace }, + { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, + { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, + { "http://schemas.microsoft.com/wix/2009/Lux", "http://wixtoolset.org/schemas/v4/lux" }, + { "http://schemas.microsoft.com/wix/2006/wi", "http://wixtoolset.org/schemas/v4/wxs" }, + { "http://schemas.microsoft.com/wix/2006/localization", "http://wixtoolset.org/schemas/v4/wxl" }, + { "http://schemas.microsoft.com/wix/2006/libraries", "http://wixtoolset.org/schemas/v4/wixlib" }, + { "http://schemas.microsoft.com/wix/2006/objects", "http://wixtoolset.org/schemas/v4/wixobj" }, + { "http://schemas.microsoft.com/wix/2006/outputs", "http://wixtoolset.org/schemas/v4/wixout" }, + { "http://schemas.microsoft.com/wix/2007/pdbs", "http://wixtoolset.org/schemas/v4/wixpdb" }, + { "http://schemas.microsoft.com/wix/2003/04/actions", "http://wixtoolset.org/schemas/v4/wi/actions" }, + { "http://schemas.microsoft.com/wix/2006/tables", "http://wixtoolset.org/schemas/v4/wi/tables" }, + { "http://schemas.microsoft.com/wix/2006/WixUnit", "http://wixtoolset.org/schemas/v4/wixunit" }, + }; + + private readonly static SortedSet Wix3Namespaces = new SortedSet + { + "http://schemas.microsoft.com/wix/2006/wi", + "http://schemas.microsoft.com/wix/2006/localization", + }; + + private readonly static SortedSet Wix4Namespaces = new SortedSet + { + "http://wixtoolset.org/schemas/v4/wxs", + "http://wixtoolset.org/schemas/v4/wxl", + }; + + private readonly Dictionary> ConvertElementMapping; + + /// + /// Instantiate a new Converter class. + /// + /// Indentation value to use when validating leading whitespace. + /// Test errors to display as warnings. + /// Test errors to ignore. + public WixConverter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null) + { + this.ConvertElementMapping = new Dictionary> + { + { WixConverter.AdminExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.AdminUISequenceSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.AdvertiseExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.ColumnElementName, this.ConvertColumnElement }, + { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, + { WixConverter.ControlElementName, this.ConvertControlElement }, + { WixConverter.ComponentElementName, this.ConvertComponentElement }, + { WixConverter.DirectoryElementName, this.ConvertDirectoryElement }, + { WixConverter.FeatureElementName, this.ConvertFeatureElement }, + { WixConverter.FileElementName, this.ConvertFileElement }, + { WixConverter.FragmentElementName, this.ConvertFragmentElement }, + { WixConverter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, + { WixConverter.ErrorElementName, this.ConvertErrorElement }, + { WixConverter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.MsiPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.MspPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.PayloadElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, + { WixConverter.ProductElementName, this.ConvertProductElement }, + { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, + { WixConverter.PublishElementName, this.ConvertPublishElement }, + { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, + { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, + { WixConverter.RowElementName, this.ConvertRowElement }, + { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, + { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, + { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, + { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, + { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, + { WixConverter.TextElementName, this.ConvertTextElement }, + { WixConverter.UITextElementName, this.ConvertUITextElement }, + { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, + { WixConverter.PropertyElementName, this.ConvertPropertyElement }, + { WixConverter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, + { WixConverter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, + }; + + this.Messaging = messaging; + + this.IndentationAmount = indentationAmount; + + this.ErrorsAsWarnings = new HashSet(this.YieldConverterTypes(errorsAsWarnings)); + + this.IgnoreErrors = new HashSet(this.YieldConverterTypes(ignoreErrors)); + } + + private int Errors { get; set; } + + private HashSet ErrorsAsWarnings { get; set; } + + private HashSet IgnoreErrors { get; set; } + + private IMessaging Messaging { get; } + + private int IndentationAmount { get; set; } + + private string SourceFile { get; set; } + + private int SourceVersion { get; set; } + + /// + /// Convert a file. + /// + /// The file to convert. + /// Option to save the converted errors that are found. + /// The number of errors found. + public int ConvertFile(string sourceFile, bool saveConvertedFile) + { + XDocument document; + + // Set the instance info. + this.Errors = 0; + this.SourceFile = sourceFile; + this.SourceVersion = 0; + + try + { + document = XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + } + catch (XmlException e) + { + this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); + + return this.Errors; + } + + this.ConvertDocument(document); + + // Fix errors if requested and necessary. + if (saveConvertedFile && 0 < this.Errors) + { + try + { + using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = true })) + { + document.Save(writer); + } + } + catch (UnauthorizedAccessException) + { + this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); + } + } + + return this.Errors; + } + + /// + /// Convert a document. + /// + /// The document to convert. + /// The number of errors found. + public int ConvertDocument(XDocument document) + { + this.Errors = 0; + this.SourceVersion = 0; + + var declaration = document.Declaration; + + // Remove the declaration. + if (null != declaration) + { + if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) + { + document.Declaration = null; + } + } + + TrimLeadingText(document); + + // Start converting the nodes at the top. + this.ConvertNodes(document.Nodes(), 0); + + return this.Errors; + } + + private void ConvertNodes(IEnumerable nodes, int level) + { + // Note we operate on a copy of the node list since we may + // remove some whitespace nodes during this processing. + foreach (var node in nodes.ToList()) + { + if (node is XText text) + { + if (!String.IsNullOrWhiteSpace(text.Value)) + { + text.Value = text.Value.Trim(); + } + else if (node.NextNode is XCData cdata) + { + this.EnsurePrecedingWhitespaceRemoved(text, node, ConverterTestType.WhitespacePrecedingNodeWrong); + } + else if (node.NextNode is XElement element) + { + this.EnsurePrecedingWhitespaceCorrect(text, node, level, ConverterTestType.WhitespacePrecedingNodeWrong); + } + else if (node.NextNode is null) // this is the space before the close element + { + if (node.PreviousNode is null || node.PreviousNode is XCData) + { + this.EnsurePrecedingWhitespaceRemoved(text, node.Parent, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + else if (level == 0) // root element's close tag + { + this.EnsurePrecedingWhitespaceCorrect(text, node, 0, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + else + { + this.EnsurePrecedingWhitespaceCorrect(text, node, level - 1, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + } + } + else if (node is XElement element) + { + this.ConvertElement(element); + + this.ConvertNodes(element.Nodes(), level + 1); + } + } + } + + private void EnsurePrecedingWhitespaceCorrect(XText whitespace, XNode node, int level, ConverterTestType testType) + { + if (!WixConverter.LeadingWhitespaceValid(this.IndentationAmount, level, whitespace.Value)) + { + var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; + + if (this.OnError(testType, node, message)) + { + WixConverter.FixupWhitespace(this.IndentationAmount, level, whitespace); + } + } + } + + private void EnsurePrecedingWhitespaceRemoved(XText whitespace, XNode node, ConverterTestType testType) + { + if (!String.IsNullOrEmpty(whitespace.Value) && whitespace.NodeType != XmlNodeType.CDATA) + { + var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; + + if (this.OnError(testType, node, message)) + { + whitespace.Remove(); + } + } + } + + private void ConvertElement(XElement element) + { + // Gather any deprecated namespaces, then update this element tree based on those deprecations. + var deprecatedToUpdatedNamespaces = new Dictionary(); + + foreach (var declaration in element.Attributes().Where(a => a.IsNamespaceDeclaration)) + { + if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + { + if (Wix3Namespaces.Contains(declaration.Value)) + { + this.SourceVersion = 3; + } + else if (Wix4Namespaces.Contains(declaration.Value)) + { + this.SourceVersion = 4; + } + + if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) + { + deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); + } + } + } + + if (deprecatedToUpdatedNamespaces.Any()) + { + WixConverter.UpdateElementsWithDeprecatedNamespaces(element.DescendantsAndSelf(), deprecatedToUpdatedNamespaces); + } + + // Apply any specialized conversion actions. + if (this.ConvertElementMapping.TryGetValue(element.Name, out var convert)) + { + convert(element); + } + } + + private void ConvertColumnElement(XElement element) + { + var category = element.Attribute("Category"); + if (category != null) + { + var camelCaseValue = LowercaseFirstChar(category.Value); + if (category.Value != camelCaseValue && + this.OnError(ConverterTestType.ColumnCategoryCamelCase, element, "The CustomTable Category attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", category.Name)) + { + category.Value = camelCaseValue; + } + } + + var modularization = element.Attribute("Modularize"); + if (modularization != null) + { + var camelCaseValue = LowercaseFirstChar(modularization.Value); + if (category.Value != camelCaseValue && + this.OnError(ConverterTestType.ColumnModularizeCamelCase, element, "The CustomTable Modularize attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", modularization.Name)) + { + modularization.Value = camelCaseValue; + } + } + } + + private void ConvertCustomTableElement(XElement element) + { + var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); + if (bootstrapperApplicationData != null + && this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) + { + element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); + bootstrapperApplicationData.Remove(); + } + } + + private void ConvertControlElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var action = UppercaseFirstChar(xCondition.Attribute("Action")?.Value); + if (!String.IsNullOrEmpty(action) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}Condition' attribute instead.", xCondition.Name.LocalName, action)) + { + element.Add(new XAttribute(action + "Condition", text)); + xCondition.Remove(); + } + } + } + + private void ConvertComponentElement(XElement element) + { + var guid = element.Attribute("Guid"); + if (guid != null && guid.Value == "*") + { + if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Component Guid attribute is unnecessary. Remove the attribute to remove the redundancy.")) + { + guid.Remove(); + } + } + + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + if (TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) + { + element.Add(new XAttribute("Condition", text)); + xCondition.Remove(); + } + } + } + + private void ConvertDirectoryElement(XElement element) + { + if (null == element.Attribute("Name")) + { + var attribute = element.Attribute("ShortName"); + if (null != attribute) + { + var shortName = attribute.Value; + if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) + { + element.Add(new XAttribute("Name", shortName)); + attribute.Remove(); + } + } + } + } + + private void ConvertFeatureElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var level = xCondition.Attribute("Level")?.Value; + if (!String.IsNullOrEmpty(level) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Level' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LevelElementName, + new XAttribute("Value", level), + new XAttribute("Condition", text) + )); + xCondition.Remove(); + } + } + } + + private void ConvertFileElement(XElement element) + { + if (this.SourceVersion < 4 && null == element.Attribute("Id")) + { + var attribute = element.Attribute("Name"); + + if (null == attribute) + { + attribute = element.Attribute("Source"); + } + + if (null != attribute) + { + var name = Path.GetFileName(attribute.Value); + + if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the v3 default", name)) + { + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + element.Add(new XAttribute("Id", GetIdentifierFromName(name))); + element.Add(attributes); + } + } + } + } + + private void ConvertFragmentElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var message = xCondition.Attribute("Message")?.Value; + + if (!String.IsNullOrEmpty(message) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LaunchElementName, + new XAttribute("Condition", text), + new XAttribute("Message", message) + )); + xCondition.Remove(); + } + } + } + + private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + + private void ConvertPermissionExElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + if (TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) + { + element.Add(new XAttribute("Condition", text)); + xCondition.Remove(); + } + } + } + + private void ConvertProgressTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + + private void ConvertProductElement(XElement element) + { + var id = element.Attribute("Id"); + if (id != null && id.Value == "*") + { + if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Product Id attribute is unnecessary. Remove the attribute to remove the redundancy.")) + { + id.Remove(); + } + } + + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var message = element.Attribute("Message")?.Value; + + if (!String.IsNullOrEmpty(message) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LaunchElementName, + new XAttribute("Condition", text), + new XAttribute("Message", message) + )); + xCondition.Remove(); + } + } + } + + private void ConvertPublishElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); + + private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSequenceElement(XElement element) + { + foreach (var child in element.Elements()) + { + this.ConvertInnerTextToAttribute(child, "Condition"); + } + } + + private void ConvertServiceArgumentElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSetDirectoryElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertSetPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSuppressSignatureValidation(XElement element) + { + var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); + + if (null != suppressSignatureValidation) + { + if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation.Name)) + { + if ("no" == suppressSignatureValidation.Value) + { + element.Add(new XAttribute("EnableSignatureValidation", "yes")); + } + } + + suppressSignatureValidation.Remove(); + } + } + + private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertCustomActionElement(XElement xCustomAction) + { + var xBinaryKey = xCustomAction.Attribute("BinaryKey"); + + if (xBinaryKey?.Value == "WixCA" || xBinaryKey?.Value == "UtilCA") + { + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X86' instead.")) + { + xBinaryKey.Value = "Wix4UtilCA_X86"; + } + } + + if (xBinaryKey?.Value == "WixCA_x64" || xBinaryKey?.Value == "UtilCA_x64") + { + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA_x64 custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X64' instead.")) + { + xBinaryKey.Value = "Wix4UtilCA_X64"; + } + } + + var xDllEntry = xCustomAction.Attribute("DllEntry"); + + if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) + { + xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); + } + } + + var xProperty = xCustomAction.Attribute("Property"); + + if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) + { + xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); + } + } + + var xScript = xCustomAction.Attribute("Script"); + + if (xScript != null && TryGetInnerText(xCustomAction, out var scriptText)) + { + if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptFile' attribute to reference it.", xCustomAction.Name.LocalName)) + { + var scriptFolder = Path.GetDirectoryName(this.SourceFile) ?? String.Empty; + var id = xCustomAction.Attribute("Id")?.Value ?? Guid.NewGuid().ToString("N"); + var ext = (xScript.Value == "jscript") ? ".js" : (xScript.Value == "vbscript") ? ".vbs" : ".txt"; + + var scriptFile = Path.Combine(scriptFolder, id + ext); + File.WriteAllText(scriptFile, scriptText); + + RemoveChildren(xCustomAction); + xCustomAction.Add(new XAttribute("ScriptFile", scriptFile)); + } + } + } + + private void ConvertPropertyElement(XElement xProperty) + { + var xId = xProperty.Attribute("Id"); + + if (xId.Value == "QtExecCmdTimeout") + { + this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); + } + + this.ConvertInnerTextToAttribute(xProperty, "Value"); + } + + private void ConvertUtilPermissionExElement(XElement element) + { + if (this.SourceVersion < 4 && null == element.Attribute("Inheritable")) + { + var inheritable = element.Parent.Name == CreateFolderElementName; + if (!inheritable) + { + if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default")) + { + element.Add(new XAttribute("Inheritable", "no")); + } + } + } + } + + /// + /// Converts a Wix element. + /// + /// The Wix element to convert. + /// The converted element. + private void ConvertElementWithoutNamespace(XElement element) + { + if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) + { + element.Name = WixNamespace.GetName(element.Name.LocalName); + + element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. + + foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) + { + elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); + } + } + } + + private void ConvertInnerTextToAttribute(XElement element, string attributeName) + { + if (TryGetInnerText(element, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}' attribute instead.", element.Name.LocalName, attributeName)) + { + element.Add(new XAttribute(attributeName, text)); + RemoveChildren(element); + } + } + + private IEnumerable YieldConverterTypes(IEnumerable types) + { + if (null != types) + { + foreach (var type in types) + { + if (Enum.TryParse(type, true, out var itt)) + { + yield return itt; + } + else // not a known ConverterTestType + { + this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); + } + } + } + } + + private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) + { + foreach (var element in elements) + { + + if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) + { + element.Name = ns.GetName(element.Name.LocalName); + } + + // Remove all the attributes and add them back to with their namespace updated (as necessary). + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + + foreach (var attribute in attributes) + { + var convertedAttribute = attribute; + + if (attribute.IsNamespaceDeclaration) + { + if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) + { + convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); + } + } + else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) + { + convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); + } + + element.Add(convertedAttribute); + } + } + } + + /// + /// Determine if the whitespace preceding a node is appropriate for its depth level. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level that should match this whitespace. + /// The whitespace to validate. + /// true if the whitespace is legal; false otherwise. + private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) + { + // Strip off leading newlines; there can be an arbitrary number of these. + whitespace = whitespace.TrimStart(XDocumentNewLine); + + var indentation = new string(' ', level * indentationAmount); + + return whitespace == indentation; + } + + /// + /// Fix the whitespace in a whitespace node. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level of the desired whitespace. + /// The whitespace node to fix. + private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) + { + var value = new StringBuilder(whitespace.Value.Length); + + // Keep any previous preceeding new lines. + var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); + + // Ensure there is always at least one new line before the indentation. + value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); + + whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); + } + + /// + /// Output an error message to the console. + /// + /// The type of converter test. + /// The node that caused the error. + /// Detailed error message. + /// Additional formatted string arguments. + /// Returns true indicating that action should be taken on this error, and false if it should be ignored. + private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) + { + if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error + { + return false; + } + + // Increase the error count. + this.Errors++; + + var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); + var warning = this.ErrorsAsWarnings.Contains(converterTestType); + var display = String.Format(CultureInfo.CurrentCulture, message, args); + + var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); + + this.Messaging.Write(msg); + + return true; + } + + /// + /// Return an identifier based on passed file/directory name + /// + /// File/directory name to generate identifer from + /// A version of the name that is a legal identifier. + /// This is duplicated from WiX's Common class. + private static string GetIdentifierFromName(string name) + { + var result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + + // MSI identifiers must begin with an alphabetic character or an + // underscore. Prefix all other values with an underscore. + if (AddPrefix.IsMatch(name)) + { + result = String.Concat("_", result); + } + + return result; + } + + private static string LowercaseFirstChar(string value) + { + if (!String.IsNullOrEmpty(value)) + { + var c = Char.ToLowerInvariant(value[0]); + if (c != value[0]) + { + var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; + return c + remainder; + } + } + + return value; + } + + private static string UppercaseFirstChar(string value) + { + if (!String.IsNullOrEmpty(value)) + { + var c = Char.ToUpperInvariant(value[0]); + if (c != value[0]) + { + var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; + return c + remainder; + } + } + + return value; + } + + private static bool TryGetInnerText(XElement element, out string value) + { + value = null; + + var nodes = element.Nodes(); + + if (nodes.All(e => e.NodeType == XmlNodeType.Text || e.NodeType == XmlNodeType.CDATA)) + { + value = String.Join(String.Empty, nodes.Cast().Select(TrimTextValue)); + } + + return !String.IsNullOrEmpty(value); + } + + private static bool IsTextNode(XNode node, out XText text) + { + text = null; + + if (node.NodeType == XmlNodeType.Text || node.NodeType == XmlNodeType.CDATA) + { + text = (XText)node; + } + + return text != null; + } + + private static void TrimLeadingText(XDocument document) + { + while (IsTextNode(document.Nodes().FirstOrDefault(), out var text)) + { + text.Remove(); + } + } + + private static string TrimTextValue(XText text) + { + var value = text.Value; + + if (String.IsNullOrEmpty(value)) + { + return String.Empty; + } + else if (text.NodeType == XmlNodeType.CDATA && String.IsNullOrWhiteSpace(value)) + { + return " "; + } + + return value.Trim(); + } + + private static void RemoveChildren(XElement element) + { + var nodes = element.Nodes().ToList(); + foreach (var node in nodes) + { + node.Remove(); + } + } + + /// + /// Converter test types. These are used to condition error messages down to warnings. + /// + private enum ConverterTestType + { + /// + /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. + /// + ConverterTestTypeUnknown, + + /// + /// Displayed when an XML loading exception has occurred. + /// + XmlException, + + /// + /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. + /// + UnauthorizedAccessException, + + /// + /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. + /// + DeclarationEncodingWrong, + + /// + /// Displayed when the XML declaration is missing from the source file. + /// + DeclarationMissing, + + /// + /// Displayed when the whitespace preceding a CDATA node is wrong. + /// + WhitespacePrecedingCDATAWrong, + + /// + /// Displayed when the whitespace preceding a node is wrong. + /// + WhitespacePrecedingNodeWrong, + + /// + /// Displayed when an element is not empty as it should be. + /// + NotEmptyElement, + + /// + /// Displayed when the whitespace following a CDATA node is wrong. + /// + WhitespaceFollowingCDATAWrong, + + /// + /// Displayed when the whitespace preceding an end element is wrong. + /// + WhitespacePrecedingEndElementWrong, + + /// + /// Displayed when the xmlns attribute is missing from the document element. + /// + XmlnsMissing, + + /// + /// Displayed when the xmlns attribute on the document element is wrong. + /// + XmlnsValueWrong, + + /// + /// Assign an identifier to a File element when on Id attribute is specified. + /// + AssignAnonymousFileId, + + /// + /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. + /// + SuppressSignatureValidationDeprecated, + + /// + /// WixCA Binary/@Id has been renamed to UtilCA. + /// + WixCABinaryIdRenamed, + + /// + /// QtExec custom actions have been renamed. + /// + QuietExecCustomActionsRenamed, + + /// + /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. + /// + QtExecCmdTimeoutAmbiguous, + + /// + /// Directory/@ShortName may only be specified with Directory/@Name. + /// + AssignDirectoryNameFromShortName, + + /// + /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. + /// + BootstrapperApplicationDataDeprecated, + + /// + /// Inheritable is new and is now defaulted to 'yes' which is a change in behavior for all but children of CreateFolder. + /// + AssignPermissionExInheritable, + + /// + /// Column element's Category attribute is camel-case. + /// + ColumnCategoryCamelCase, + + /// + /// Column element's Modularize attribute is camel-case. + /// + ColumnModularizeCamelCase, + + /// + /// Inner text value should move to an attribute. + /// + InnerTextDeprecated, + + /// + /// Explicit auto-GUID unnecessary. + /// + AutoGuidUnnecessary, + + /// + /// Displayed when the XML declaration is present in the source file. + /// + DeclarationPresent, + } + } +} diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 804ebe5b..3fa7c031 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -45,7 +45,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(3, errors); @@ -81,7 +81,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(3, errors); @@ -117,7 +117,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(3, errors); @@ -151,7 +151,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(3, errors); @@ -192,7 +192,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(3, errors); diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 10029090..c205df39 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -29,7 +29,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -62,7 +62,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 4, null, null); + var converter = new WixConverter(messaging, 4, null, null); var errors = converter.ConvertDocument(document); @@ -97,7 +97,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 4, null, null); + var converter = new WixConverter(messaging, 4, null, null); var conversions = converter.ConvertDocument(document); @@ -133,7 +133,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 4, null, null); + var converter = new WixConverter(messaging, 4, null, null); var conversions = converter.ConvertDocument(document); @@ -160,7 +160,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -188,7 +188,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -220,7 +220,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -249,7 +249,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -277,7 +277,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -315,7 +315,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -343,7 +343,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -370,7 +370,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -396,7 +396,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -422,7 +422,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index d4fd1acf..5eaeb985 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -28,7 +28,7 @@ namespace WixToolsetTest.Converters File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 4); + var converter = new WixConverter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); Assert.Equal(8, errors); @@ -55,7 +55,7 @@ namespace WixToolsetTest.Converters File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 4); + var converter = new WixConverter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); Assert.Equal(7, errors); @@ -164,7 +164,7 @@ namespace WixToolsetTest.Converters private static void EnsureFixed(string targetFile) { var messaging2 = new MockMessaging(); - var converter2 = new Wix3Converter(messaging2, 4); + var converter2 = new WixConverter(messaging2, 4); var errors2 = converter2.ConvertFile(targetFile, true); Assert.Equal(0, errors2); } diff --git a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs index 27d45bc6..e19de6e3 100644 --- a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs @@ -34,7 +34,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -72,7 +72,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs index b61dbb10..10ee2748 100644 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -37,7 +37,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(4, errors); @@ -75,7 +75,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(3, errors); @@ -114,7 +114,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(2, errors); @@ -150,7 +150,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(2, errors); @@ -175,7 +175,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); diff --git a/src/test/WixToolsetTest.Converters/PropertyFixture.cs b/src/test/WixToolsetTest.Converters/PropertyFixture.cs index 90c1e5c9..e50a6518 100644 --- a/src/test/WixToolsetTest.Converters/PropertyFixture.cs +++ b/src/test/WixToolsetTest.Converters/PropertyFixture.cs @@ -32,7 +32,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -66,7 +66,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); @@ -96,7 +96,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); var actual = UnformattedDocumentString(document); diff --git a/src/test/WixToolsetTest.Converters/SequenceFixture.cs b/src/test/WixToolsetTest.Converters/SequenceFixture.cs index 1abe6c0c..2fbc4d4a 100644 --- a/src/test/WixToolsetTest.Converters/SequenceFixture.cs +++ b/src/test/WixToolsetTest.Converters/SequenceFixture.cs @@ -36,7 +36,7 @@ namespace WixToolsetTest.Converters var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new Wix3Converter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); Assert.Equal(2, errors); -- cgit v1.2.3-55-g6feb From f0544d8b04951ea0c9ccd03bcdd8284a96bc569c Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 26 Jun 2020 14:04:15 -0700 Subject: Ensure Include elements have correct namespace Fixes wixtoolset/issues#5891 --- .../WixToolsetTest.Converters/IncludeFixture.cs | 67 ++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/IncludeFixture.cs (limited to 'src') diff --git a/src/test/WixToolsetTest.Converters/IncludeFixture.cs b/src/test/WixToolsetTest.Converters/IncludeFixture.cs new file mode 100644 index 00000000..7be2c030 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/IncludeFixture.cs @@ -0,0 +1,67 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class IncludeFixture : BaseConverterFixture + { + [Fact] + public void EnsureNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = new[] + { + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = new[] + { + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From f17f7138de534891a2605c9a86c0acc36cc41154 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 26 Jun 2020 14:55:16 -0700 Subject: Add inner text conversions for Util.wixext --- src/WixToolset.Converters/WixConverter.cs | 8 +++ .../UtilExtensionFixture.cs | 79 ++++++++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index a89d44ce..89d33598 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -63,7 +63,9 @@ namespace WixToolset.Converters private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; private static readonly XName TextElementName = WixNamespace + "Text"; private static readonly XName UITextElementName = WixNamespace + "UIText"; + private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; + private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; private static readonly XName PropertyElementName = WixNamespace + "Property"; private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; @@ -156,7 +158,9 @@ namespace WixToolset.Converters { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, { WixConverter.TextElementName, this.ConvertTextElement }, { WixConverter.UITextElementName, this.ConvertUITextElement }, + { WixConverter.UtilCloseApplicationElementName, this.ConvertUtilCloseApplicationElementName }, { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, + { WixConverter.UtilXmlConfigElementName, this.ConvertUtilXmlConfigElement }, { WixConverter.PropertyElementName, this.ConvertPropertyElement }, { WixConverter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, { WixConverter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, @@ -692,6 +696,8 @@ namespace WixToolset.Converters this.ConvertInnerTextToAttribute(xProperty, "Value"); } + private void ConvertUtilCloseApplicationElementName(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + private void ConvertUtilPermissionExElement(XElement element) { if (this.SourceVersion < 4 && null == element.Attribute("Inheritable")) @@ -707,6 +713,8 @@ namespace WixToolset.Converters } } + private void ConvertUtilXmlConfigElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + /// /// Converts a Wix element. /// diff --git a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs new file mode 100644 index 00000000..d9c58160 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs @@ -0,0 +1,79 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class UtilExtensionFixture : BaseConverterFixture + { + [Fact] + public void FixCloseAppsCondition() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " a<>b", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixXmlConfigValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " a<>b", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From c8e5b2b045b35bd6e5b8b2021a3173df16500887 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 27 Jun 2020 22:55:44 -0700 Subject: Correctly detect wix4 for better conversions --- src/WixToolset.Converters/WixConverter.cs | 23 ++++++---- .../WixToolsetTest.Converters/ConverterFixture.cs | 4 +- .../Wix4ConversionFixture.cs | 53 ++++++++++++++++++++++ 3 files changed, 69 insertions(+), 11 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 89d33598..7ac64710 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -24,6 +24,7 @@ namespace WixToolset.Converters private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; + private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; @@ -68,7 +69,11 @@ namespace WixToolset.Converters private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; private static readonly XName PropertyElementName = WixNamespace + "Property"; + private static readonly XName Wix4ElementName = WixNamespace + "Wix"; + private static readonly XName Wix3ElementName = Wix3Namespace + "Wix"; private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; + private static readonly XName Include4ElementName = WixNamespace + "Include"; + private static readonly XName Include3ElementName = Wix3Namespace + "Include"; private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() @@ -343,17 +348,17 @@ namespace WixToolset.Converters foreach (var declaration in element.Attributes().Where(a => a.IsNamespaceDeclaration)) { - if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + if (element.Name == Wix3ElementName || element.Name == Include3ElementName) { - if (Wix3Namespaces.Contains(declaration.Value)) - { - this.SourceVersion = 3; - } - else if (Wix4Namespaces.Contains(declaration.Value)) - { - this.SourceVersion = 4; - } + this.SourceVersion = 3; + } + else if (element.Name == Wix4ElementName || element.Name == Include4ElementName) + { + this.SourceVersion = 4; + } + if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + { if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) { deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index c205df39..6e2ad2c5 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -331,7 +331,7 @@ namespace WixToolsetTest.Converters { var parse = String.Join(Environment.NewLine, "", - "", + "", " ", ""); @@ -349,7 +349,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(2, errors); + Assert.Equal(3, errors); Assert.Equal(expected, actual); } diff --git a/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs b/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs new file mode 100644 index 00000000..a3f2adc8 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs @@ -0,0 +1,53 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class Wix4ConversionFixture : BaseConverterFixture + { + [Fact] + public void DoesNotAddFileId() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 48aea40184697a5394875e07aac2293da10875bb Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 27 Jun 2020 23:53:04 -0700 Subject: Handle multiple Condition conversions --- src/WixToolset.Converters/WixConverter.cs | 24 ++++++++++++++++------ .../WixToolsetTest.Converters/ConditionFixture.cs | 12 ++++++++--- 2 files changed, 27 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 7ac64710..86a1bfba 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -416,8 +416,9 @@ namespace WixToolset.Converters private void ConvertControlElement(XElement element) { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) + var remove = new List(); + + foreach (var xCondition in element.Elements(ConditionElementName)) { var action = UppercaseFirstChar(xCondition.Attribute("Action")?.Value); if (!String.IsNullOrEmpty(action) && @@ -425,9 +426,14 @@ namespace WixToolset.Converters this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}Condition' attribute instead.", xCondition.Name.LocalName, action)) { element.Add(new XAttribute(action + "Condition", text)); - xCondition.Remove(); + remove.Add(xCondition); } } + + for (var i = remove.Count - 1; i >= 0; i--) + { + remove[i].Remove(); + } } private void ConvertComponentElement(XElement element) @@ -517,8 +523,9 @@ namespace WixToolset.Converters private void ConvertFragmentElement(XElement element) { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) + var remove = new List(); + + foreach (var xCondition in element.Elements(ConditionElementName)) { var message = xCondition.Attribute("Message")?.Value; @@ -530,9 +537,14 @@ namespace WixToolset.Converters new XAttribute("Condition", text), new XAttribute("Message", message) )); - xCondition.Remove(); + remove.Add(xCondition); } } + + for (var i = remove.Count - 1; i >= 0; i--) + { + remove[i].Remove(); + } } private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 3fa7c031..1b8a7604 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -20,6 +20,7 @@ namespace WixToolsetTest.Converters " ", " ", " ", + " x=y", " a<>b", " ", " ", @@ -33,7 +34,8 @@ namespace WixToolsetTest.Converters " ", " ", " ", - " ", + " ", + " ", " ", " ", " ", @@ -48,7 +50,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); + Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); @@ -136,6 +138,9 @@ namespace WixToolsetTest.Converters " ", " 1<2", " ", + " ", + " 1=2", + " ", " ", ""); @@ -144,6 +149,7 @@ namespace WixToolsetTest.Converters "", " ", " ", + " ", " ", "" }; @@ -154,7 +160,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); + Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); -- cgit v1.2.3-55-g6feb From ea4fe9e10a1236262011f845585ae94154964a86 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 1 Jul 2020 00:07:05 -0700 Subject: Convert Firewall/RemoteAddress inner text to Value attribute --- src/WixToolset.Converters/WixConverter.cs | 7 +- .../FirewallExtensionFixture.cs | 79 ++++++++++++++++++++++ 2 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 86a1bfba..73538d56 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -26,6 +26,7 @@ namespace WixToolset.Converters private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; + private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall"; private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; private static readonly XName AdminUISequenceSequenceElementName = WixNamespace + "AdminUISequence"; @@ -40,10 +41,11 @@ namespace WixToolset.Converters private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; + private static readonly XName ErrorElementName = WixNamespace + "Error"; private static readonly XName FeatureElementName = WixNamespace + "Feature"; private static readonly XName FileElementName = WixNamespace + "File"; private static readonly XName FragmentElementName = WixNamespace + "Fragment"; - private static readonly XName ErrorElementName = WixNamespace + "Error"; + private static readonly XName FirewallRemoteAddressElementName = WixFirewallNamespace + "RemoteAddress"; private static readonly XName LaunchElementName = WixNamespace + "Launch"; private static readonly XName LevelElementName = WixNamespace + "Level"; private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; @@ -142,6 +144,7 @@ namespace WixToolset.Converters { WixConverter.FeatureElementName, this.ConvertFeatureElement }, { WixConverter.FileElementName, this.ConvertFileElement }, { WixConverter.FragmentElementName, this.ConvertFragmentElement }, + { WixConverter.FirewallRemoteAddressElementName, this.ConvertFirewallRemoteAddressElement }, { WixConverter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, { WixConverter.ErrorElementName, this.ConvertErrorElement }, { WixConverter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, @@ -547,6 +550,8 @@ namespace WixToolset.Converters } } + private void ConvertFirewallRemoteAddressElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); diff --git a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs new file mode 100644 index 00000000..72571cd8 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs @@ -0,0 +1,79 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class FirewallExtensionFixture : BaseConverterFixture + { + [Fact] + public void FixRemoteAddressValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " 127.0.0.1", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixXmlConfigValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " a<>b", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 181aa7076a5bdc4d554d29ec9f96dc923e40a6ed Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 1 Jul 2020 00:10:08 -0700 Subject: Make Publish/@Condition truly optional There is a change to the Core to add the condition back --- src/WixToolset.Converters/WixConverter.cs | 11 +++++- .../WixToolsetTest.Converters/ConditionFixture.cs | 46 ++++++++++++++++++++++ 2 files changed, 56 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 73538d56..c18b095e 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -601,7 +601,16 @@ namespace WixToolset.Converters } } - private void ConvertPublishElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + private void ConvertPublishElement(XElement element) + { + this.ConvertInnerTextToAttribute(element, "Condition"); + + var xCondition = element.Attribute("Condition"); + if (xCondition?.Value == "1") + { + xCondition.Remove(); + } + } private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 1b8a7604..34f99306 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -56,6 +56,52 @@ namespace WixToolsetTest.Converters CompareLineByLine(expected, actualLines); } + [Fact] + public void FixPublishCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " 1<2", + " 1", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + [Fact] public void FixComponentCondition() { -- cgit v1.2.3-55-g6feb From 3f0af880a3d8a41e1a6ac342f8fba06d22b223a0 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 1 Jul 2020 01:59:21 -0700 Subject: Make Feature/@Absent and Feature/@AllowAdvertise consistent Conversion for wixtoolset/issues#5990 --- src/WixToolset.Converters/WixConverter.cs | 36 ++++++++++ .../WixToolsetTest.Converters/FeatureFixture.cs | 77 ++++++++++++++++++++++ 2 files changed, 113 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/FeatureFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c18b095e..a05c7f58 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -481,6 +481,32 @@ namespace WixToolset.Converters private void ConvertFeatureElement(XElement element) { + var xAbsent = element.Attribute("Absent"); + if (xAbsent != null && + this.OnError(ConverterTestType.FeatureAbsentAttributeReplaced, element, "The Feature element's Absent attribute has been replaced with the AllowAbsent attribute. Use the 'AllowAbsent' attribute instead.")) + { + if (xAbsent.Value == "allow") + { + element.Add(new XAttribute("AllowAbsent", "yes")); + } + xAbsent.Remove(); + } + + var xAllowAdvertise = element.Attribute("AllowAdvertise"); + if (xAllowAdvertise != null) + { + if ((xAllowAdvertise.Value == "system" || xAllowAdvertise.Value == "allow") && + this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value deprecated. Set the value to 'yes' instead.", xAllowAdvertise.Value)) + { + xAllowAdvertise.Value = "yes"; + } + else if (xAllowAdvertise.Value == "disallow" && + this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value deprecated. Remove the value instead.", xAllowAdvertise.Value)) + { + xAllowAdvertise.Remove(); + } + } + var xCondition = element.Element(ConditionElementName); if (xCondition != null) { @@ -1132,6 +1158,16 @@ namespace WixToolset.Converters /// Displayed when the XML declaration is present in the source file. /// DeclarationPresent, + + /// + /// The Feature Absent attribute renamed to AllowAbsent. + /// + FeatureAbsentAttributeReplaced, + + /// + /// The Feature AllowAdvertise attribute value deprecated. + /// + FeatureAllowAdvertiseValueDeprecated, } } } diff --git a/src/test/WixToolsetTest.Converters/FeatureFixture.cs b/src/test/WixToolsetTest.Converters/FeatureFixture.cs new file mode 100644 index 00000000..9d943773 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/FeatureFixture.cs @@ -0,0 +1,77 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class FeatureFixture : BaseConverterFixture + { + [Fact] + public void FixAllowAttributes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void RemoveDeprecatedAllowAdvertiseAttributes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 92bb1d2d74e46714459c2d0fc23f185329745718 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sun, 5 Jul 2020 23:27:10 -0700 Subject: Store short filenames in separate fields --- .../ConvertSymbols.cs | 62 +++++++++++++++++++--- .../ConvertSymbolsFixture.cs | 2 +- 2 files changed, 57 insertions(+), 7 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index 76a0440f..ca75d3c2 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -197,7 +197,20 @@ namespace WixToolset.Converters.Symbolizer case "DrLocator": return DefaultSymbolFromRow(typeof(DrLocatorSymbol), row, columnZeroIsId: false); case "DuplicateFile": - return DefaultSymbolFromRow(typeof(DuplicateFileSymbol), row, columnZeroIsId: true); + { + var splitName = FieldAsString(row, 3)?.Split('|'); + + var symbol = new DuplicateFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileRef = FieldAsString(row, 2), + DestinationName = splitName == null ? null : splitName.Length > 1 ? splitName[1] : splitName[0], + DestinationShortName = splitName == null ? null : splitName.Length > 1 ? splitName[0] : null, + DestinationFolder = FieldAsString(row, 4) + }; + + return symbol; + } case "Error": return DefaultSymbolFromRow(typeof(ErrorSymbol), row, columnZeroIsId: false); case "Extension": @@ -246,11 +259,13 @@ namespace WixToolset.Converters.Symbolizer symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileSymbolAttributes.Compressed : 0; var id = FieldAsString(row, 0); + var splitName = FieldAsString(row, 2).Split('|'); var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) { ComponentRef = FieldAsString(row, 1), - Name = FieldAsString(row, 2), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, FileSize = FieldAsInt(row, 3), Version = FieldAsString(row, 4), Language = FieldAsString(row, 5), @@ -278,7 +293,6 @@ namespace WixToolset.Converters.Symbolizer symbol.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; symbol.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; symbol.PatchGroup = FieldAsInt(wixFileRow, 8); - symbol.Attributes |= FieldAsInt(wixFileRow, 9) != 0 ? FileSymbolAttributes.GeneratedShortFileName : 0; symbol.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); } @@ -288,8 +302,41 @@ namespace WixToolset.Converters.Symbolizer return null; case "Icon": return DefaultSymbolFromRow(typeof(IconSymbol), row, columnZeroIsId: true); + case "IniFile": + { + var splitName = FieldAsString(row, 1).Split('|'); + var action = FieldAsInt(row, 6); + + var symbol = new IniFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + FileName = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortFileName = splitName.Length > 1 ? splitName[0] : null, + DirProperty = FieldAsString(row, 2), + Section = FieldAsString(row, 3), + Key = FieldAsString(row, 4), + Value = FieldAsString(row, 5), + Action = action == 3 ? InifFileActionType.AddTag : action == 1 ? InifFileActionType.CreateLine : InifFileActionType.AddLine, + ComponentRef = FieldAsString(row, 7), + }; + + return symbol; + } case "IniLocator": - return DefaultSymbolFromRow(typeof(IniLocatorSymbol), row, columnZeroIsId: false); + { + var splitName = FieldAsString(row, 1).Split('|'); + + var symbol = new IniLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + { + FileName = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortFileName = splitName.Length > 1 ? splitName[0] : null, + Section = FieldAsString(row, 2), + Key = FieldAsString(row, 3), + Field = FieldAsInt(row, 4), + Type = FieldAsInt(row, 5), + }; + + return symbol; + } case "LockPermissions": return DefaultSymbolFromRow(typeof(LockPermissionsSymbol), row, columnZeroIsId: false); case "Media": @@ -423,12 +470,15 @@ namespace WixToolset.Converters.Symbolizer } case "RemoveFile": { + var splitName = FieldAsString(row, 2).Split('|'); var installMode = FieldAsInt(row, 4); + return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) { ComponentRef = FieldAsString(row, 1), - FileName = FieldAsString(row, 2), - DirProperty = FieldAsString(row, 3), + FileName = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortFileName = splitName.Length > 1 ? splitName[0] : null, + DirPropertyRef = FieldAsString(row, 3), OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null }; diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs index ae054079..01213524 100644 --- a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs +++ b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs @@ -317,7 +317,7 @@ namespace WixToolsetTest.Converters.Symbolizer fileSymbol.Source.Path, null, // assembly processor arch fileSymbol.PatchGroup, - (fileSymbol.Attributes & FileSymbolAttributes.GeneratedShortFileName) != 0 ? 1 : 0, + 0, (int)fileSymbol.PatchAttributes, fileSymbol.RetainLengths, fileSymbol.IgnoreOffsets, -- cgit v1.2.3-55-g6feb From e04caab11fb8f2cac4d575ef1e352221bd421586 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 18 Jul 2020 14:57:08 -0700 Subject: Separate "format" from "convert" Closes wixtoolset/issues#6215 --- src/WixToolset.Converters/ConvertCommand.cs | 269 ++------------------- .../ConverterExtensionCommandLine.cs | 11 +- src/WixToolset.Converters/FixupCommandBase.cs | 267 ++++++++++++++++++++ src/WixToolset.Converters/FormatCommand.cs | 60 +++++ src/WixToolset.Converters/WixConverter.cs | 179 ++++++++------ .../WixToolsetTest.Converters/ConverterFixture.cs | 104 -------- .../ConverterIntegrationFixture.cs | 10 +- .../WixToolsetTest.Converters/FormatFixture.cs | 117 +++++++++ 8 files changed, 589 insertions(+), 428 deletions(-) create mode 100644 src/WixToolset.Converters/FixupCommandBase.cs create mode 100644 src/WixToolset.Converters/FormatCommand.cs create mode 100644 src/test/WixToolsetTest.Converters/FormatFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs index 51e7b997..50ca7249 100644 --- a/src/WixToolset.Converters/ConvertCommand.cs +++ b/src/WixToolset.Converters/ConvertCommand.cs @@ -3,283 +3,58 @@ namespace WixToolset.Converters { using System; - using System.Collections.Generic; - using System.IO; using System.Threading; using System.Threading.Tasks; - using System.Xml; - using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; - internal class ConvertCommand : ICommandLineCommand + internal class ConvertCommand : FixupCommandBase { - private const string SettingsFileDefault = "wixcop.settings.xml"; + private const string SettingsFileDefault = "wix.convert.settings.xml"; public ConvertCommand(IWixToolsetServiceProvider serviceProvider) { this.Messaging = serviceProvider.GetService(); - - this.IndentationAmount = 4; // default indentation amount - this.ErrorsAsWarnings = new HashSet(); - this.ExemptFiles = new HashSet(); - this.IgnoreErrors = new HashSet(); - this.SearchPatternResults = new HashSet(); - this.SearchPatterns = new List(); } private IMessaging Messaging { get; } - public bool ShowLogo { get; private set; } - - public bool StopParsing { get; private set; } - - private bool ShowHelp { get; set; } - - private HashSet ErrorsAsWarnings { get; } - - private HashSet ExemptFiles { get; } - - private bool FixErrors { get; set; } - - private int IndentationAmount { get; set; } - - private HashSet IgnoreErrors { get; } - - private HashSet SearchPatternResults { get; } - - private List SearchPatterns { get; } - - private string SettingsFile1 { get; set; } - - private string SettingsFile2 { get; set; } - - private bool SubDirectories { get; set; } - - public bool TryParseArgument(ICommandLineParser parser, string argument) - { - if (!parser.IsSwitch(argument)) - { - this.SearchPatterns.Add(argument); - return true; - } - - var parameter = argument.Substring(1); - switch (parameter.ToLowerInvariant()) - { - case "?": - this.ShowHelp = true; - this.ShowLogo = true; - this.StopParsing = true; - return true; - - case "f": - this.FixErrors = true; - return true; - - case "nologo": - this.ShowLogo = false; - return true; - - case "s": - this.SubDirectories = true; - return true; - - default: // other parameters - if (parameter.StartsWith("set1", StringComparison.Ordinal)) - { - this.SettingsFile1 = parameter.Substring(4); - return true; - } - else if (parameter.StartsWith("set2", StringComparison.Ordinal)) - { - this.SettingsFile2 = parameter.Substring(4); - return true; - } - else if (parameter.StartsWith("indent:", StringComparison.Ordinal)) - { - try - { - this.IndentationAmount = Convert.ToInt32(parameter.Substring(7)); - } - catch - { - parser.ErrorArgument = parameter; // $"Invalid numeric argument: {parameter}"; - } - return true; - } - - return false; - } - } - - public Task ExecuteAsync(CancellationToken cancellationToken) + public override Task ExecuteAsync(CancellationToken cancellationToken) { if (this.ShowHelp) { DisplayHelp(); - return Task.FromResult(1); - } - - // parse the settings if any were specified - if (null != this.SettingsFile1 || null != this.SettingsFile2) - { - this.ParseSettingsFiles(this.SettingsFile1, this.SettingsFile2); - } - else - { - if (File.Exists(ConvertCommand.SettingsFileDefault)) - { - this.ParseSettingsFiles(ConvertCommand.SettingsFileDefault, null); - } + return Task.FromResult(-1); } var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); - var errors = this.InspectSubDirectories(converter, Path.GetFullPath("."), cancellationToken); + this.ParseSettings(SettingsFileDefault); + + var errors = base.Inspect(Inspector, cancellationToken); - foreach (var searchPattern in this.SearchPatterns) + return Task.FromResult(errors); + + int Inspector(string file, bool fix) { - if (!this.SearchPatternResults.Contains(searchPattern)) - { - Console.Error.WriteLine("Could not find file \"{0}\"", searchPattern); - errors++; - } + return converter.ConvertFile(file, fix); } - - return Task.FromResult(errors != 0 ? 2 : 0); } private static void DisplayHelp() { - Console.WriteLine(" usage: wix.exe convert sourceFile [sourceFile ...]"); Console.WriteLine(); - Console.WriteLine(" -f fix errors automatically for writable files"); - Console.WriteLine(" -nologo suppress displaying the logo information"); - Console.WriteLine(" -s search for matching files in current dir and subdirs"); - Console.WriteLine(" -set1 primary settings file"); - Console.WriteLine(" -set2 secondary settings file (overrides primary)"); - Console.WriteLine(" -indent: indentation multiple (overrides default of 4)"); - Console.WriteLine(" -? this help information"); + Console.WriteLine("Usage: wix convert [options] sourceFile [sourceFile ...]"); Console.WriteLine(); - Console.WriteLine(" sourceFile may use wildcards like *.wxs"); - } - - /// - /// Get the files that match a search path pattern. - /// - /// The base directory at which to begin the search. - /// The search path pattern. - /// The files matching the pattern. - private static string[] GetFiles(string baseDir, string searchPath) - { - // convert alternate directory separators to the standard one - var filePath = searchPath.Replace(Path.AltDirectorySeparatorChar, Path.DirectorySeparatorChar); - var lastSeparator = filePath.LastIndexOf(Path.DirectorySeparatorChar); - string[] files = null; - - try - { - if (0 > lastSeparator) - { - files = Directory.GetFiles(baseDir, filePath); - } - else // found directory separator - { - var searchPattern = filePath.Substring(lastSeparator + 1); - - files = Directory.GetFiles(filePath.Substring(0, lastSeparator + 1), searchPattern); - } - } - catch (DirectoryNotFoundException) - { - // don't let this function throw the DirectoryNotFoundException. (this exception - // occurs for non-existant directories and invalid characters in the searchPattern) - } - - return files; - } - - /// - /// Inspect sub-directories. - /// - /// The directory whose sub-directories will be inspected. - /// The number of errors that were found. - private int InspectSubDirectories(WixConverter converter, string directory, CancellationToken cancellationToken) - { - var errors = 0; - - foreach (var searchPattern in this.SearchPatterns) - { - foreach (var sourceFilePath in GetFiles(directory, searchPattern)) - { - cancellationToken.ThrowIfCancellationRequested(); - - var file = new FileInfo(sourceFilePath); - - if (!this.ExemptFiles.Contains(file.Name.ToUpperInvariant())) - { - this.SearchPatternResults.Add(searchPattern); - errors += converter.ConvertFile(file.FullName, this.FixErrors); - } - } - } - - if (this.SubDirectories) - { - foreach (var childDirectoryPath in Directory.GetDirectories(directory)) - { - errors += this.InspectSubDirectories(converter, childDirectoryPath, cancellationToken); - } - } - - return errors; - } - - /// - /// Parse the primary and secondary settings files. - /// - /// The primary settings file. - /// The secondary settings file. - private void ParseSettingsFiles(string localSettingsFile1, string localSettingsFile2) - { - if (null == localSettingsFile1 && null != localSettingsFile2) - { - throw new ArgumentException("Cannot specify a secondary settings file (set2) without a primary settings file (set1).", nameof(localSettingsFile2)); - } - - var settingsFile = localSettingsFile1; - while (null != settingsFile) - { - var doc = new XmlDocument(); - doc.Load(settingsFile); - - // get the types of tests that will have their errors displayed as warnings - var testsIgnoredElements = doc.SelectNodes("/Settings/IgnoreErrors/Test"); - foreach (XmlElement test in testsIgnoredElements) - { - var key = test.GetAttribute("Id"); - this.IgnoreErrors.Add(key); - } - - // get the types of tests that will have their errors displayed as warnings - var testsAsWarningsElements = doc.SelectNodes("/Settings/ErrorsAsWarnings/Test"); - foreach (XmlElement test in testsAsWarningsElements) - { - var key = test.GetAttribute("Id"); - this.ErrorsAsWarnings.Add(key); - } - - // get the exempt files - var localExemptFiles = doc.SelectNodes("/Settings/ExemptFiles/File"); - foreach (XmlElement file in localExemptFiles) - { - var key = file.GetAttribute("Name").ToUpperInvariant(); - this.ExemptFiles.Add(key); - } - - settingsFile = localSettingsFile2; - localSettingsFile2 = null; - } + Console.WriteLine("Options:"); + Console.WriteLine(" -h|--help Show command line help."); + Console.WriteLine(" --nologo Suppress displaying the logo information."); + Console.WriteLine(" -n|--dry-run Only display errors, do not update files."); + Console.WriteLine(" -r|--recurse Search for matching files in current dir and subdirs."); + Console.WriteLine(" -set1 Primary settings file."); + Console.WriteLine(" -set2 Secondary settings file (overrides primary)."); + Console.WriteLine(" -indent: Indentation multiple (overrides default of 4)."); + Console.WriteLine(); + Console.WriteLine(" sourceFile may use wildcards like *.wxs"); } } } diff --git a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs index ed4b613e..d78b89cc 100644 --- a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs +++ b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs @@ -21,8 +21,11 @@ namespace WixToolset.Converters private IWixToolsetServiceProvider ServiceProvider { get; } - // TODO: Do something with CommandLineSwitches - public override IEnumerable CommandLineSwitches => base.CommandLineSwitches; + public override IEnumerable CommandLineSwitches => new ExtensionCommandLineSwitch[] + { + new ExtensionCommandLineSwitch { Switch = "convert", Description = "Convert v3 source code to v4 source code." }, + new ExtensionCommandLineSwitch { Switch = "format", Description = "Ensures consistent formatting of source code." }, + }; public override bool TryParseCommand(ICommandLineParser parser, string argument, out ICommandLineCommand command) { @@ -32,6 +35,10 @@ namespace WixToolset.Converters { command = new ConvertCommand(this.ServiceProvider); } + else if ("format".Equals(argument, StringComparison.OrdinalIgnoreCase)) + { + command = new FormatCommand(this.ServiceProvider); + } return command != null; } diff --git a/src/WixToolset.Converters/FixupCommandBase.cs b/src/WixToolset.Converters/FixupCommandBase.cs new file mode 100644 index 00000000..0f58fbdb --- /dev/null +++ b/src/WixToolset.Converters/FixupCommandBase.cs @@ -0,0 +1,267 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Threading; + using System.Threading.Tasks; + using System.Xml; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + internal abstract class FixupCommandBase : ICommandLineCommand + { + protected FixupCommandBase() + { + this.IndentationAmount = 4; // default indentation amount + this.ErrorsAsWarnings = new HashSet(); + this.ExemptFiles = new HashSet(); + this.IgnoreErrors = new HashSet(); + this.SearchPatternResults = new HashSet(); + this.SearchPatterns = new List(); + } + + public bool ShowLogo { get; private set; } + + public bool StopParsing { get; private set; } + + protected bool ShowHelp { get; set; } + + protected bool DryRun { get; set; } + + protected HashSet ErrorsAsWarnings { get; } + + protected HashSet IgnoreErrors { get; } + + protected HashSet ExemptFiles { get; } + + protected int IndentationAmount { get; set; } + + protected bool Recurse { get; set; } + + private HashSet SearchPatternResults { get; } + + private List SearchPatterns { get; } + + private string SettingsFile1 { get; set; } + + private string SettingsFile2 { get; set; } + + public bool TryParseArgument(ICommandLineParser parser, string argument) + { + if (!parser.IsSwitch(argument)) + { + this.SearchPatterns.Add(argument); + return true; + } + + var parameter = argument.Substring(1); + switch (parameter.ToLowerInvariant()) + { + case "?": + case "h": + case "-help": + this.ShowHelp = true; + this.ShowLogo = true; + this.StopParsing = true; + return true; + + case "n": + case "--dry-run": + this.DryRun = true; + return true; + + case "nologo": + case "-nologo": + this.ShowLogo = false; + return true; + + case "s": + case "r": + case "-recurse": + this.Recurse = true; + return true; + + default: // other parameters + if (parameter.StartsWith("set1", StringComparison.Ordinal)) + { + this.SettingsFile1 = parameter.Substring(4); + return true; + } + else if (parameter.StartsWith("set2", StringComparison.Ordinal)) + { + this.SettingsFile2 = parameter.Substring(4); + return true; + } + else if (parameter.StartsWith("indent:", StringComparison.Ordinal)) + { + try + { + this.IndentationAmount = Convert.ToInt32(parameter.Substring(7)); + } + catch + { + parser.ErrorArgument = parameter; // $"Invalid numeric argument: {parameter}"; + } + return true; + } + + return false; + } + } + + public abstract Task ExecuteAsync(CancellationToken cancellationToken); + + protected void ParseSettings(string defaultSettingsFile) + { + // parse the settings if any were specified + if (null != this.SettingsFile1 || null != this.SettingsFile2) + { + this.ParseSettingsFiles(this.SettingsFile1, this.SettingsFile2); + } + else + { + if (File.Exists(defaultSettingsFile)) + { + this.ParseSettingsFiles(defaultSettingsFile, null); + } + } + } + + protected int Inspect(Func inspector, CancellationToken cancellationToken) + { + var errors = this.InspectSubDirectories(inspector, Path.GetFullPath("."), cancellationToken); + + foreach (var searchPattern in this.SearchPatterns) + { + if (!this.SearchPatternResults.Contains(searchPattern)) + { + Console.Error.WriteLine("Could not find file \"{0}\"", searchPattern); + errors++; + } + } + + return errors; + } + + /// + /// Inspect sub-directories. + /// + /// The directory whose sub-directories will be inspected. + /// The number of errors that were found. + private int InspectSubDirectories(Func inspector, string directory, CancellationToken cancellationToken) + { + var errors = 0; + + foreach (var searchPattern in this.SearchPatterns) + { + foreach (var sourceFilePath in GetFiles(directory, searchPattern)) + { + cancellationToken.ThrowIfCancellationRequested(); + + var file = new FileInfo(sourceFilePath); + + if (!this.ExemptFiles.Contains(file.Name.ToUpperInvariant())) + { + this.SearchPatternResults.Add(searchPattern); + errors += inspector(file.FullName, !this.DryRun); + } + } + } + + if (this.Recurse) + { + foreach (var childDirectoryPath in Directory.GetDirectories(directory)) + { + errors += this.InspectSubDirectories(inspector, childDirectoryPath, cancellationToken); + } + } + + return errors; + } + + /// + /// Parse the primary and secondary settings files. + /// + /// The primary settings file. + /// The secondary settings file. + private void ParseSettingsFiles(string localSettingsFile1, string localSettingsFile2) + { + if (null == localSettingsFile1 && null != localSettingsFile2) + { + throw new ArgumentException("Cannot specify a secondary settings file (set2) without a primary settings file (set1).", nameof(localSettingsFile2)); + } + + var settingsFile = localSettingsFile1; + while (null != settingsFile) + { + var doc = new XmlDocument(); + doc.Load(settingsFile); + + // get the types of tests that will have their errors displayed as warnings + var testsIgnoredElements = doc.SelectNodes("/Settings/IgnoreErrors/Test"); + foreach (XmlElement test in testsIgnoredElements) + { + var key = test.GetAttribute("Id"); + this.IgnoreErrors.Add(key); + } + + // get the types of tests that will have their errors displayed as warnings + var testsAsWarningsElements = doc.SelectNodes("/Settings/ErrorsAsWarnings/Test"); + foreach (XmlElement test in testsAsWarningsElements) + { + var key = test.GetAttribute("Id"); + this.ErrorsAsWarnings.Add(key); + } + + // get the exempt files + var localExemptFiles = doc.SelectNodes("/Settings/ExemptFiles/File"); + foreach (XmlElement file in localExemptFiles) + { + var key = file.GetAttribute("Name").ToUpperInvariant(); + this.ExemptFiles.Add(key); + } + + settingsFile = localSettingsFile2; + localSettingsFile2 = null; + } + } + + /// + /// Get the files that match a search path pattern. + /// + /// The base directory at which to begin the search. + /// The search path pattern. + /// The files matching the pattern. + private static string[] GetFiles(string baseDir, string searchPath) + { + // convert alternate directory separators to the standard one + var filePath = searchPath.Replace(Path.AltDirectorySeparatorChar, Path.DirectorySeparatorChar); + var lastSeparator = filePath.LastIndexOf(Path.DirectorySeparatorChar); + string[] files = null; + + try + { + if (0 > lastSeparator) + { + files = Directory.GetFiles(baseDir, filePath); + } + else // found directory separator + { + var searchPattern = filePath.Substring(lastSeparator + 1); + + files = Directory.GetFiles(filePath.Substring(0, lastSeparator + 1), searchPattern); + } + } + catch (DirectoryNotFoundException) + { + // don't let this function throw the DirectoryNotFoundException. (this exception + // occurs for non-existant directories and invalid characters in the searchPattern) + } + + return files; + } + } +} diff --git a/src/WixToolset.Converters/FormatCommand.cs b/src/WixToolset.Converters/FormatCommand.cs new file mode 100644 index 00000000..e9965df3 --- /dev/null +++ b/src/WixToolset.Converters/FormatCommand.cs @@ -0,0 +1,60 @@ +// 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.Converters +{ + using System; + using System.Threading; + using System.Threading.Tasks; + using WixToolset.Extensibility.Services; + + internal class FormatCommand : FixupCommandBase + { + private const string SettingsFileDefault = "wix.format.settings.xml"; + + public FormatCommand(IWixToolsetServiceProvider serviceProvider) + { + this.Messaging = serviceProvider.GetService(); + } + + private IMessaging Messaging { get; } + + public override Task ExecuteAsync(CancellationToken cancellationToken) + { + if (this.ShowHelp) + { + DisplayHelp(); + return Task.FromResult(-1); + } + + var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); + + this.ParseSettings(SettingsFileDefault); + + var errors = base.Inspect(Inspector, cancellationToken); + + return Task.FromResult(errors); + + int Inspector(string file, bool fix) + { + return converter.FormatFile(file, fix); + } + } + + private static void DisplayHelp() + { + Console.WriteLine(); + Console.WriteLine("Usage: wix format [options] sourceFile [sourceFile ...]"); + Console.WriteLine(); + Console.WriteLine("Options:"); + Console.WriteLine(" -h|--help Show command line help."); + Console.WriteLine(" --nologo Suppress displaying the logo information."); + Console.WriteLine(" -n|--dry-run Only display errors, do not update files."); + Console.WriteLine(" -r|--recurse Search for matching files in current dir and subdirs."); + Console.WriteLine(" -set1 Primary settings file."); + Console.WriteLine(" -set2 Secondary settings file (overrides primary)."); + Console.WriteLine(" -indent: Indentation multiple (overrides default of 4)."); + Console.WriteLine(); + Console.WriteLine(" sourceFile may use wildcards like *.wxs"); + } + } +} diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index a05c7f58..bfeed03e 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -19,6 +19,12 @@ namespace WixToolset.Converters /// public class WixConverter { + private enum ConvertOperation + { + Convert, + Format, + } + private static readonly Regex AddPrefix = new Regex(@"^[^a-zA-Z_]", RegexOptions.Compiled); private static readonly Regex IllegalIdentifierCharacters = new Regex(@"[^A-Za-z0-9_\.]|\.{2,}", RegexOptions.Compiled); // non 'words' and assorted valid characters @@ -107,18 +113,6 @@ namespace WixToolset.Converters { "http://schemas.microsoft.com/wix/2006/WixUnit", "http://wixtoolset.org/schemas/v4/wixunit" }, }; - private readonly static SortedSet Wix3Namespaces = new SortedSet - { - "http://schemas.microsoft.com/wix/2006/wi", - "http://schemas.microsoft.com/wix/2006/localization", - }; - - private readonly static SortedSet Wix4Namespaces = new SortedSet - { - "http://wixtoolset.org/schemas/v4/wxs", - "http://wixtoolset.org/schemas/v4/wxl", - }; - private readonly Dictionary> ConvertElementMapping; /// @@ -193,6 +187,8 @@ namespace WixToolset.Converters private int IndentationAmount { get; set; } + private ConvertOperation Operation { get; set; } + private string SourceFile { get; set; } private int SourceVersion { get; set; } @@ -205,22 +201,11 @@ namespace WixToolset.Converters /// The number of errors found. public int ConvertFile(string sourceFile, bool saveConvertedFile) { - XDocument document; - - // Set the instance info. - this.Errors = 0; - this.SourceFile = sourceFile; - this.SourceVersion = 0; + var document = this.OpenSourceFile(sourceFile); - try + if (document is null) { - document = XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - } - catch (XmlException e) - { - this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); - - return this.Errors; + return 1; } this.ConvertDocument(document); @@ -228,17 +213,7 @@ namespace WixToolset.Converters // Fix errors if requested and necessary. if (saveConvertedFile && 0 < this.Errors) { - try - { - using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = true })) - { - document.Save(writer); - } - } - catch (UnauthorizedAccessException) - { - this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); - } + this.SaveDocument(document); } return this.Errors; @@ -251,13 +226,68 @@ namespace WixToolset.Converters /// The number of errors found. public int ConvertDocument(XDocument document) { + // Reset the instance info. this.Errors = 0; this.SourceVersion = 0; + this.Operation = ConvertOperation.Convert; + + // Remove the declaration. + if (null != document.Declaration) + { + if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) + { + document.Declaration = null; + } + } + + TrimLeadingText(document); + + // Start converting the nodes at the top. + this.ConvertNodes(document.Nodes(), 0); + + return this.Errors; + } - var declaration = document.Declaration; + /// + /// Format a file. + /// + /// The file to format. + /// Option to save the format errors that are found. + /// The number of errors found. + public int FormatFile(string sourceFile, bool saveConvertedFile) + { + var document = this.OpenSourceFile(sourceFile); + + if (document is null) + { + return 1; + } + + this.FormatDocument(document); + + // Fix errors if requested and necessary. + if (saveConvertedFile && 0 < this.Errors) + { + this.SaveDocument(document); + } + + return this.Errors; + } + + /// + /// Format a document. + /// + /// The document to format. + /// The number of errors found. + public int FormatDocument(XDocument document) + { + // Reset the instance info. + this.Errors = 0; + this.SourceVersion = 0; + this.Operation = ConvertOperation.Format; // Remove the declaration. - if (null != declaration) + if (null != document.Declaration) { if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) { @@ -273,6 +303,37 @@ namespace WixToolset.Converters return this.Errors; } + private XDocument OpenSourceFile(string sourceFile) + { + this.SourceFile = sourceFile; + + try + { + return XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + } + catch (XmlException e) + { + this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); + } + + return null; + } + + private void SaveDocument(XDocument document) + { + try + { + using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = true })) + { + document.Save(writer); + } + } + catch (UnauthorizedAccessException) + { + this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); + } + } + private void ConvertNodes(IEnumerable nodes, int level) { // Note we operate on a copy of the node list since we may @@ -901,7 +962,10 @@ namespace WixToolset.Converters /// Returns true indicating that action should be taken on this error, and false if it should be ignored. private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) { - if (this.IgnoreErrors.Contains(converterTestType)) // ignore the error + // Ignore the error if explicitly ignored or outside the range of the current operation. + if (this.IgnoreErrors.Contains(converterTestType) || + (this.Operation == ConvertOperation.Convert && converterTestType < ConverterTestType.DeclarationPresent) || + (this.Operation == ConvertOperation.Format && converterTestType > ConverterTestType.DeclarationPresent)) { return false; } @@ -909,7 +973,7 @@ namespace WixToolset.Converters // Increase the error count. this.Errors++; - var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wixcop.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); + var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wix.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); var warning = this.ErrorsAsWarnings.Contains(converterTestType); var display = String.Format(CultureInfo.CurrentCulture, message, args); @@ -1049,40 +1113,20 @@ namespace WixToolset.Converters /// UnauthorizedAccessException, - /// - /// Displayed when the encoding attribute in the XML declaration is not 'UTF-8'. - /// - DeclarationEncodingWrong, - - /// - /// Displayed when the XML declaration is missing from the source file. - /// - DeclarationMissing, - - /// - /// Displayed when the whitespace preceding a CDATA node is wrong. - /// - WhitespacePrecedingCDATAWrong, - /// /// Displayed when the whitespace preceding a node is wrong. /// WhitespacePrecedingNodeWrong, /// - /// Displayed when an element is not empty as it should be. - /// - NotEmptyElement, - - /// - /// Displayed when the whitespace following a CDATA node is wrong. + /// Displayed when the whitespace preceding an end element is wrong. /// - WhitespaceFollowingCDATAWrong, + WhitespacePrecedingEndElementWrong, /// - /// Displayed when the whitespace preceding an end element is wrong. + /// Displayed when the XML declaration is present in the source file. /// - WhitespacePrecedingEndElementWrong, + DeclarationPresent, /// /// Displayed when the xmlns attribute is missing from the document element. @@ -1154,11 +1198,6 @@ namespace WixToolset.Converters /// AutoGuidUnnecessary, - /// - /// Displayed when the XML declaration is present in the source file. - /// - DeclarationPresent, - /// /// The Feature Absent attribute renamed to AllowAbsent. /// diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 6e2ad2c5..cf89ba7e 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -39,110 +39,6 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } - [Fact] - public void CanFixWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(5, errors); - } - - [Fact] - public void CanPreserveNewLines() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - "", - " ", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - "", - " ", - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4, null, null); - - var conversions = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(4, conversions); - } - - [Fact] - public void CanConvertWithNewLineAtEndOfFile() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - "", - " ", - "", - " ", - "", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - "", - " ", - "", - " ", - "", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4, null, null); - - var conversions = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(3, conversions); - } - [Fact] public void CanConvertMainNamespace() { diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index 5eaeb985..79cc3f69 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -84,7 +84,7 @@ namespace WixToolsetTest.Converters var settingsFile = Path.Combine(folder, "wixcop.settings.xml"); var result = RunConversion(targetFile, settingsFile: settingsFile); - Assert.Equal(2, result.ExitCode); + Assert.Equal(7, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -108,7 +108,7 @@ namespace WixToolsetTest.Converters File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); var result = RunConversion(targetFile); - Assert.Equal(2, result.ExitCode); + Assert.Equal(10, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -133,7 +133,7 @@ namespace WixToolsetTest.Converters var result = RunConversion(targetFile); - Assert.Equal(2, result.ExitCode); + Assert.Equal(10, result.ExitCode); Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); @@ -142,7 +142,7 @@ namespace WixToolsetTest.Converters // still fails because QtExecCmdTimeoutAmbiguous is unfixable var result2 = RunConversion(targetFile); - Assert.Equal(2, result2.ExitCode); + Assert.Equal(1, result2.ExitCode); } } @@ -153,7 +153,7 @@ namespace WixToolsetTest.Converters var exitCode = WixRunner.Execute(new[] { "convert", - fixErrors ? "-f" : null, + fixErrors ? null : "--dry-run", String.IsNullOrEmpty(settingsFile) ? null : "-set1" + settingsFile, targetFile }, serviceProvider, out var messages); diff --git a/src/test/WixToolsetTest.Converters/FormatFixture.cs b/src/test/WixToolsetTest.Converters/FormatFixture.cs new file mode 100644 index 00000000..739fba66 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/FormatFixture.cs @@ -0,0 +1,117 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class FormatFixture : BaseConverterFixture + { + [Fact] + public void CanFixWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4, null, null); + + var errors = converter.FormatDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(5, errors); + } + + [Fact] + public void CanPreserveNewLines() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + "", + " ", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + "", + " ", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4, null, null); + + var conversions = converter.FormatDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(4, conversions); + } + + [Fact] + public void CanFormatWithNewLineAtEndOfFile() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + "", + " ", + "", + " ", + "", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + "", + " ", + "", + " ", + "", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4, null, null); + + var conversions = converter.FormatDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(3, conversions); + } + } +} -- cgit v1.2.3-55-g6feb From 901e856ef5c72be5fc7cfb3077e2e60892ddd4cc Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 18 Jul 2020 14:57:45 -0700 Subject: Correctly report error when Publish/@Condition='1' --- src/WixToolset.Converters/WixConverter.cs | 8 +++++++- src/test/WixToolsetTest.Converters/ConditionFixture.cs | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index bfeed03e..3ea0c3dc 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -693,7 +693,8 @@ namespace WixToolset.Converters this.ConvertInnerTextToAttribute(element, "Condition"); var xCondition = element.Attribute("Condition"); - if (xCondition?.Value == "1") + if (xCondition?.Value == "1" && + this.OnError(ConverterTestType.PublishConditionOneUnnecessary, element, "Adding Condition='1' on {0} elements is no longer necessary. Remove the Condition attribute.", xCondition.Name.LocalName)) { xCondition.Remove(); } @@ -1207,6 +1208,11 @@ namespace WixToolset.Converters /// The Feature AllowAdvertise attribute value deprecated. /// FeatureAllowAdvertiseValueDeprecated, + + /// + /// The Condition='1' attribute is unnecessary on Publish elements. + /// + PublishConditionOneUnnecessary } } } diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 34f99306..d8e5b392 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -96,7 +96,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); + Assert.Equal(5, errors); var actualLines = UnformattedDocumentLines(document); CompareLineByLine(expected, actualLines); -- cgit v1.2.3-55-g6feb From ecad1128c6223920a035cd12502e316452e61c93 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sun, 19 Jul 2020 19:08:40 +1000 Subject: Set DpiAwareness to "unaware" from v3. --- src/WixToolset.Converters/WixConverter.cs | 18 ++++- .../BootstrapperApplicationFixture.cs | 76 ++++++++++++++++++++++ 2 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 3ea0c3dc..c9ebdfd3 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -39,6 +39,7 @@ namespace WixToolset.Converters private static readonly XName AdvertiseExecuteSequenceElementName = WixNamespace + "AdvertiseExecuteSequence"; private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; + private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication"; private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; private static readonly XName ColumnElementName = WixNamespace + "Column"; private static readonly XName ComponentElementName = WixNamespace + "Component"; @@ -130,6 +131,7 @@ namespace WixToolset.Converters { WixConverter.AdvertiseExecuteSequenceElementName, this.ConvertSequenceElement }, { WixConverter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement }, { WixConverter.ColumnElementName, this.ConvertColumnElement }, { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, { WixConverter.ControlElementName, this.ConvertControlElement }, @@ -442,6 +444,15 @@ namespace WixToolset.Converters } } + private void ConvertBootstrapperApplicationElement(XElement element) + { + if (this.SourceVersion < 4 && null == element.Attribute("DpiAwareness") && + this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplication DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default")) + { + element.Add(new XAttribute("DpiAwareness", "unaware")); + } + } + private void ConvertColumnElement(XElement element) { var category = element.Attribute("Category"); @@ -1212,7 +1223,12 @@ namespace WixToolset.Converters /// /// The Condition='1' attribute is unnecessary on Publish elements. /// - PublishConditionOneUnnecessary + PublishConditionOneUnnecessary, + + /// + /// DpiAwareness is new and is defaulted to 'perMonitorV2' which is a change in behavior. + /// + AssignBootstrapperApplicationDpiAwareness, } } } diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs new file mode 100644 index 00000000..1551077b --- /dev/null +++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -0,0 +1,76 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class BootstrapperApplicationFixture : BaseConverterFixture + { + [Fact] + public void SetsDpiUnawareFromV3() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(2, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + + [Fact] + public void DoesntSetDpiUnawareFromV4() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(0, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 84a26c3bf9d7a88a7dcbbca4d65b004307600ba2 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Tue, 4 Aug 2020 19:08:10 -0600 Subject: WIXFEAT:4763 Change "string" variable type to literal and add "formatted". --- src/WixToolset.Converters/WixConverter.cs | 54 ++++++++++++++ .../WixToolsetTest.Converters/VariableFixture.cs | 86 ++++++++++++++++++++++ 2 files changed, 140 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/VariableFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c9ebdfd3..e4903bcb 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -73,6 +73,7 @@ namespace WixToolset.Converters private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; private static readonly XName TextElementName = WixNamespace + "Text"; private static readonly XName UITextElementName = WixNamespace + "UIText"; + private static readonly XName VariableElementName = WixNamespace + "Variable"; private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; @@ -162,6 +163,7 @@ namespace WixToolset.Converters { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, { WixConverter.TextElementName, this.ConvertTextElement }, { WixConverter.UITextElementName, this.ConvertUITextElement }, + { WixConverter.VariableElementName, this.ConvertVariableElement }, { WixConverter.UtilCloseApplicationElementName, this.ConvertUtilCloseApplicationElementName }, { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, { WixConverter.UtilXmlConfigElementName, this.ConvertUtilXmlConfigElement }, @@ -814,6 +816,28 @@ namespace WixToolset.Converters } } + private void ConvertVariableElement(XElement xVariable) + { + var xType = xVariable.Attribute("Type"); + var xValue = xVariable.Attribute("Value"); + if (this.SourceVersion < 4) + { + if (xType == null) + { + if (WasImplicitlyStringTyped(xValue?.Value) && + this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) + { + xVariable.Add(new XAttribute("Type", "formatted")); + } + } + else if (xType.Value == "string" && + this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) + { + xType.Value = "formatted"; + } + } + } + private void ConvertPropertyElement(XElement xProperty) { var xId = xProperty.Attribute("Id"); @@ -1105,6 +1129,31 @@ namespace WixToolset.Converters } } + private static bool WasImplicitlyStringTyped(string value) + { + if (value == null) + { + return false; + } + else if (value.StartsWith("v", StringComparison.OrdinalIgnoreCase)) + { + if (Int32.TryParse(value.Substring(1), NumberStyles.None, CultureInfo.InvariantCulture.NumberFormat, out var _)) + { + return false; + } + else if (Version.TryParse(value.Substring(1), out var _)) + { + return false; + } + } + else if (Int64.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture.NumberFormat, out var _)) + { + return false; + } + + return true; + } + /// /// Converter test types. These are used to condition error messages down to warnings. /// @@ -1229,6 +1278,11 @@ namespace WixToolset.Converters /// DpiAwareness is new and is defaulted to 'perMonitorV2' which is a change in behavior. /// AssignBootstrapperApplicationDpiAwareness, + + /// + /// The string variable type was previously treated as formatted. + /// + AssignVariableTypeFormatted, } } } diff --git a/src/test/WixToolsetTest.Converters/VariableFixture.cs b/src/test/WixToolsetTest.Converters/VariableFixture.cs new file mode 100644 index 00000000..b7b7388f --- /dev/null +++ b/src/test/WixToolsetTest.Converters/VariableFixture.cs @@ -0,0 +1,86 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class VariableFixture : BaseConverterFixture + { + [Fact] + public void FixFormattedType() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void DoesntFixFormattedTypeFromV4() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(0, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 732158ca8f82721c5e0ed772c4eb6bab39ac36ce Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Mon, 17 Aug 2020 15:00:40 -0500 Subject: Only target all frameworks in Release --- .../WixToolset.Converters.Symbolizer.csproj | 7 ++++--- src/WixToolset.Converters/WixToolset.Converters.csproj | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj index 4aad6d07..f0ea99c6 100644 --- a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj +++ b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj @@ -1,10 +1,11 @@ - + - netstandard2.0;net461;net472 + netstandard2.0 + $(TargetFrameworks);net461;net472 Symbolizer WiX Toolset Converters Tuplizer embedded @@ -29,6 +30,6 @@ - + diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj index ad003e27..424a393b 100644 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -1,10 +1,11 @@ - + - netstandard2.0;net461;net472 + netstandard2.0 + $(TargetFrameworks);net461;net472 Converter WiX Toolset Converters embedded @@ -21,6 +22,6 @@ - + -- cgit v1.2.3-55-g6feb From c2d23a0d9c4d7b7205a288b1aa912b7f8d68702d Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Tue, 25 Aug 2020 14:58:01 -0400 Subject: Fix custom table & custom action decompilation. --- src/WixToolset.Converters/WixConverter.cs | 9 ++++++--- .../CustomActionFixture.cs | 2 +- .../CustomTableFixture.cs | 22 +++++++++++++++------- 3 files changed, 22 insertions(+), 11 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index e4903bcb..f6918702 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -47,6 +47,7 @@ namespace WixToolset.Converters private static readonly XName ConditionElementName = WixNamespace + "Condition"; private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; + private static readonly XName DataElementName = WixNamespace + "Data"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; private static readonly XName ErrorElementName = WixNamespace + "Error"; private static readonly XName FeatureElementName = WixNamespace + "Feature"; @@ -137,6 +138,7 @@ namespace WixToolset.Converters { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, { WixConverter.ControlElementName, this.ConvertControlElement }, { WixConverter.ComponentElementName, this.ConvertComponentElement }, + { WixConverter.DataElementName, this.ConvertDataElement }, { WixConverter.DirectoryElementName, this.ConvertDirectoryElement }, { WixConverter.FeatureElementName, this.ConvertFeatureElement }, { WixConverter.FileElementName, this.ConvertFileElement }, @@ -155,7 +157,6 @@ namespace WixToolset.Converters { WixConverter.PublishElementName, this.ConvertPublishElement }, { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, - { WixConverter.RowElementName, this.ConvertRowElement }, { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, @@ -719,6 +720,8 @@ namespace WixToolset.Converters private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertDataElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertSequenceElement(XElement element) { foreach (var child in element.Elements()) @@ -801,7 +804,7 @@ namespace WixToolset.Converters if (xScript != null && TryGetInnerText(xCustomAction, out var scriptText)) { - if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptFile' attribute to reference it.", xCustomAction.Name.LocalName)) + if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptSourceFile' attribute to reference it.", xCustomAction.Name.LocalName)) { var scriptFolder = Path.GetDirectoryName(this.SourceFile) ?? String.Empty; var id = xCustomAction.Attribute("Id")?.Value ?? Guid.NewGuid().ToString("N"); @@ -811,7 +814,7 @@ namespace WixToolset.Converters File.WriteAllText(scriptFile, scriptText); RemoveChildren(xCustomAction); - xCustomAction.Add(new XAttribute("ScriptFile", scriptFile)); + xCustomAction.Add(new XAttribute("ScriptSourceFile", scriptFile)); } } } diff --git a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs index e19de6e3..4ad7dcfd 100644 --- a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs @@ -60,7 +60,7 @@ namespace WixToolsetTest.Converters var expected = String.Join(Environment.NewLine, "", - " ", + " ", ""); var expectedScript = String.Join("\n", diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs index 10ee2748..4470a2ff 100644 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -54,8 +54,10 @@ namespace WixToolsetTest.Converters "", " ", " ", - " ", + " ", + " ", " Some value", + " ", " ", " ", " ", @@ -66,7 +68,9 @@ namespace WixToolsetTest.Converters "", " ", " ", - " ", + " ", + " ", + " ", " ", " ", "" @@ -91,10 +95,12 @@ namespace WixToolsetTest.Converters "", " ", " ", - " ", - " ", + " ", + " ", + " ", + " ", " ", " ", " ", @@ -105,7 +111,9 @@ namespace WixToolsetTest.Converters "", " ", " ", - " ", + " ", + " ", + " ", " ", " ", "" -- cgit v1.2.3-55-g6feb From cdef9c078068b7dc23b348b2142dc13dd5a936fb Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Mon, 31 Aug 2020 16:33:53 -0400 Subject: Convert Feature/@Absent=disallow to AllowAbsent=no. --- src/WixToolset.Converters/WixConverter.cs | 8 ++--- .../WixToolsetTest.Converters/FeatureFixture.cs | 34 +++++++++++++++++++++- 2 files changed, 37 insertions(+), 5 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index f6918702..f10875f1 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -560,9 +560,9 @@ namespace WixToolset.Converters if (xAbsent != null && this.OnError(ConverterTestType.FeatureAbsentAttributeReplaced, element, "The Feature element's Absent attribute has been replaced with the AllowAbsent attribute. Use the 'AllowAbsent' attribute instead.")) { - if (xAbsent.Value == "allow") + if (xAbsent.Value == "disallow") { - element.Add(new XAttribute("AllowAbsent", "yes")); + element.Add(new XAttribute("AllowAbsent", "no")); } xAbsent.Remove(); } @@ -571,12 +571,12 @@ namespace WixToolset.Converters if (xAllowAdvertise != null) { if ((xAllowAdvertise.Value == "system" || xAllowAdvertise.Value == "allow") && - this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value deprecated. Set the value to 'yes' instead.", xAllowAdvertise.Value)) + this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value is deprecated. Set the value to 'yes' instead.", xAllowAdvertise.Value)) { xAllowAdvertise.Value = "yes"; } else if (xAllowAdvertise.Value == "disallow" && - this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value deprecated. Remove the value instead.", xAllowAdvertise.Value)) + this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value is deprecated. Remove the value instead.", xAllowAdvertise.Value)) { xAllowAdvertise.Remove(); } diff --git a/src/test/WixToolsetTest.Converters/FeatureFixture.cs b/src/test/WixToolsetTest.Converters/FeatureFixture.cs index 9d943773..8240945d 100644 --- a/src/test/WixToolsetTest.Converters/FeatureFixture.cs +++ b/src/test/WixToolsetTest.Converters/FeatureFixture.cs @@ -25,7 +25,7 @@ namespace WixToolsetTest.Converters { "", " ", - " ", + " ", " ", "" }; @@ -42,6 +42,38 @@ namespace WixToolsetTest.Converters CompareLineByLine(expected, actualLines); } + [Fact] + public void FixDisallowAttributes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + CompareLineByLine(expected, actualLines); + } + [Fact] public void RemoveDeprecatedAllowAdvertiseAttributes() { -- cgit v1.2.3-55-g6feb From 941c7cae67823ed7da82d5f6f43233b7364eefc9 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Wed, 2 Sep 2020 20:24:16 -0400 Subject: Converters fixes and cleanup. - Support keeping the XML declaration. - Parse settings files earlier so they...work. - Fix typo. --- .../ConvertSymbols.cs | 2 +- src/WixToolset.Converters/ConvertCommand.cs | 4 ++-- src/WixToolset.Converters/WixConverter.cs | 26 +++++++++----------- .../BaseConverterFixture.cs | 18 ++++---------- .../BootstrapperApplicationFixture.cs | 4 ++-- .../WixToolsetTest.Converters/ConditionFixture.cs | 13 +++++----- .../WixToolsetTest.Converters/ConverterFixture.cs | 28 ++++++++++++++++++++++ .../CustomTableFixture.cs | 9 +++---- .../WixToolsetTest.Converters/FeatureFixture.cs | 7 +++--- .../FirewallExtensionFixture.cs | 5 ++-- .../WixToolsetTest.Converters/IncludeFixture.cs | 5 ++-- .../WixToolsetTest.Converters/SequenceFixture.cs | 3 ++- .../UtilExtensionFixture.cs | 5 ++-- .../Wix4ConversionFixture.cs | 3 ++- 14 files changed, 77 insertions(+), 55 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index ca75d3c2..4fb891f9 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -315,7 +315,7 @@ namespace WixToolset.Converters.Symbolizer Section = FieldAsString(row, 3), Key = FieldAsString(row, 4), Value = FieldAsString(row, 5), - Action = action == 3 ? InifFileActionType.AddTag : action == 1 ? InifFileActionType.CreateLine : InifFileActionType.AddLine, + Action = action == 3 ? IniFileActionType.AddTag : action == 1 ? IniFileActionType.CreateLine : IniFileActionType.AddLine, ComponentRef = FieldAsString(row, 7), }; diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs index 50ca7249..e29b176e 100644 --- a/src/WixToolset.Converters/ConvertCommand.cs +++ b/src/WixToolset.Converters/ConvertCommand.cs @@ -26,10 +26,10 @@ namespace WixToolset.Converters return Task.FromResult(-1); } - var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); - this.ParseSettings(SettingsFileDefault); + var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); + var errors = base.Inspect(Inspector, cancellationToken); return Task.FromResult(errors); diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index f10875f1..5f6ee2df 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -237,16 +237,13 @@ namespace WixToolset.Converters this.Operation = ConvertOperation.Convert; // Remove the declaration. - if (null != document.Declaration) + if (null != document.Declaration + && this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) { - if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) - { - document.Declaration = null; - } + document.Declaration = null; + TrimLeadingText(document); } - TrimLeadingText(document); - // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); @@ -292,16 +289,13 @@ namespace WixToolset.Converters this.Operation = ConvertOperation.Format; // Remove the declaration. - if (null != document.Declaration) + if (null != document.Declaration + && this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) { - if (this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) - { - document.Declaration = null; - } + document.Declaration = null; + TrimLeadingText(document); } - TrimLeadingText(document); - // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); @@ -326,9 +320,11 @@ namespace WixToolset.Converters private void SaveDocument(XDocument document) { + var ignoreDeclarationError = this.IgnoreErrors.Contains(ConverterTestType.DeclarationPresent); + try { - using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = true })) + using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = !ignoreDeclarationError })) { document.Save(writer); } diff --git a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs index 2cd4119b..2421d73b 100644 --- a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs @@ -11,12 +11,12 @@ namespace WixToolsetTest.Converters public abstract class BaseConverterFixture { - protected static string UnformattedDocumentString(XDocument document) + protected static string UnformattedDocumentString(XDocument document, bool omitXmlDeclaration = true) { var sb = new StringBuilder(); using (var writer = new StringWriter(sb)) - using (var xml = XmlWriter.Create(writer, new XmlWriterSettings { OmitXmlDeclaration = true })) + using (var xml = XmlWriter.Create(writer, new XmlWriterSettings { OmitXmlDeclaration = omitXmlDeclaration })) { document.Save(xml); } @@ -24,20 +24,10 @@ namespace WixToolsetTest.Converters return sb.ToString().TrimStart(); } - protected static string[] UnformattedDocumentLines(XDocument document) + protected static string[] UnformattedDocumentLines(XDocument document, bool omitXmlDeclaration = true) { - var unformatted = UnformattedDocumentString(document); + var unformatted = UnformattedDocumentString(document, omitXmlDeclaration); return unformatted.Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries); } - - protected static void CompareLineByLine(string[] expectedLines, string[] actualLines) - { - for (var i = 0; i < expectedLines.Length; ++i) - { - Assert.True(actualLines.Length > i, $"{i}: Expected file longer than actual file"); - Assert.Equal($"{i}: {expectedLines[i]}", $"{i}: {actualLines[i]}"); - } - Assert.True(expectedLines.Length == actualLines.Length, "Actual file longer than expected file"); - } } } diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs index 1551077b..68a8afc8 100644 --- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs +++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -39,7 +39,7 @@ namespace WixToolsetTest.Converters Assert.Equal(2, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -70,7 +70,7 @@ namespace WixToolsetTest.Converters Assert.Equal(0, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index d8e5b392..65fa6734 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -53,7 +54,7 @@ namespace WixToolsetTest.Converters Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -99,7 +100,7 @@ namespace WixToolsetTest.Converters Assert.Equal(5, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -135,7 +136,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -171,7 +172,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -209,7 +210,7 @@ namespace WixToolsetTest.Converters Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -250,7 +251,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index cf89ba7e..29f34412 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -39,6 +39,34 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } + [Fact] + public void EnsuresDeclarationWhenIgnored() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, ignoreErrors: new[] { "DeclarationPresent" } ); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document, omitXmlDeclaration: false); + + Assert.Equal(0, errors); + Assert.Equal(expected, actual); + } + [Fact] public void CanConvertMainNamespace() { diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs index 4470a2ff..c51d1923 100644 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -43,7 +44,7 @@ namespace WixToolsetTest.Converters Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -85,7 +86,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -128,7 +129,7 @@ namespace WixToolsetTest.Converters Assert.Equal(2, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -164,7 +165,7 @@ namespace WixToolsetTest.Converters Assert.Equal(2, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] diff --git a/src/test/WixToolsetTest.Converters/FeatureFixture.cs b/src/test/WixToolsetTest.Converters/FeatureFixture.cs index 8240945d..1df94a81 100644 --- a/src/test/WixToolsetTest.Converters/FeatureFixture.cs +++ b/src/test/WixToolsetTest.Converters/FeatureFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -39,7 +40,7 @@ namespace WixToolsetTest.Converters Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -71,7 +72,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -103,7 +104,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs index 72571cd8..e6ec8568 100644 --- a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs +++ b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -40,7 +41,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -73,7 +74,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/IncludeFixture.cs b/src/test/WixToolsetTest.Converters/IncludeFixture.cs index 7be2c030..2fd8244f 100644 --- a/src/test/WixToolsetTest.Converters/IncludeFixture.cs +++ b/src/test/WixToolsetTest.Converters/IncludeFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -34,7 +35,7 @@ namespace WixToolsetTest.Converters Assert.Equal(1, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -61,7 +62,7 @@ namespace WixToolsetTest.Converters Assert.Equal(1, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/SequenceFixture.cs b/src/test/WixToolsetTest.Converters/SequenceFixture.cs index 2fbc4d4a..ec6c709b 100644 --- a/src/test/WixToolsetTest.Converters/SequenceFixture.cs +++ b/src/test/WixToolsetTest.Converters/SequenceFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -42,7 +43,7 @@ namespace WixToolsetTest.Converters Assert.Equal(2, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs index d9c58160..9d55af79 100644 --- a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs +++ b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -40,7 +41,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } [Fact] @@ -73,7 +74,7 @@ namespace WixToolsetTest.Converters Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } diff --git a/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs b/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs index a3f2adc8..16a68895 100644 --- a/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs +++ b/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs @@ -4,6 +4,7 @@ namespace WixToolsetTest.Converters { using System; using System.Xml.Linq; + using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -47,7 +48,7 @@ namespace WixToolsetTest.Converters Assert.Equal(1, errors); var actualLines = UnformattedDocumentLines(document); - CompareLineByLine(expected, actualLines); + WixAssert.CompareLineByLine(expected, actualLines); } } } -- cgit v1.2.3-55-g6feb From 04e2665cf230390c458edcc91ad0bac4b43e9195 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Sun, 6 Sep 2020 21:14:12 -0400 Subject: Replace BinaryKey with BinaryRef and FileKey with FileRef. --- src/WixToolset.Converters/WixConverter.cs | 20 +++++++++++++++++++- .../ConverterIntegrationFixture.cs | 4 ++-- .../WixToolsetTest.Converters/CustomActionFixture.cs | 10 +++++----- .../TestData/QtExec.bad/v4_expected.wxs | 2 +- .../TestData/QtExec/v4_expected.wxs | 2 +- 5 files changed, 28 insertions(+), 10 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 5f6ee2df..b82c4490 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -469,7 +469,7 @@ namespace WixToolset.Converters if (modularization != null) { var camelCaseValue = LowercaseFirstChar(modularization.Value); - if (category.Value != camelCaseValue && + if (modularization.Value != camelCaseValue && this.OnError(ConverterTestType.ColumnModularizeCamelCase, element, "The CustomTable Modularize attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", modularization.Name)) { modularization.Value = camelCaseValue; @@ -759,6 +759,19 @@ namespace WixToolset.Converters private void ConvertCustomActionElement(XElement xCustomAction) { var xBinaryKey = xCustomAction.Attribute("BinaryKey"); + if (xBinaryKey != null && this.OnError(ConverterTestType.CustomActionKeysAreNowRefs, xCustomAction, "The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef.")) + { + xCustomAction.SetAttributeValue("BinaryRef", xBinaryKey.Value); + xBinaryKey.Remove(); + xBinaryKey = xCustomAction.Attribute("BinaryRef"); + } + + var xFileKey = xCustomAction.Attribute("FileKey"); + if (xFileKey != null && this.OnError(ConverterTestType.CustomActionKeysAreNowRefs, xCustomAction, "The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef.")) + { + xCustomAction.SetAttributeValue("FileRef", xFileKey.Value); + xFileKey.Remove(); + } if (xBinaryKey?.Value == "WixCA" || xBinaryKey?.Value == "UtilCA") { @@ -1282,6 +1295,11 @@ namespace WixToolset.Converters /// The string variable type was previously treated as formatted. /// AssignVariableTypeFormatted, + + /// + /// The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef. + /// + CustomActionKeysAreNowRefs, } } } diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index 79cc3f69..09387590 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -108,7 +108,7 @@ namespace WixToolsetTest.Converters File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); var result = RunConversion(targetFile); - Assert.Equal(10, result.ExitCode); + Assert.Equal(11, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -133,7 +133,7 @@ namespace WixToolsetTest.Converters var result = RunConversion(targetFile); - Assert.Equal(10, result.ExitCode); + Assert.Equal(11, result.ExitCode); Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); diff --git a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs index 4ad7dcfd..eafc171a 100644 --- a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs @@ -25,10 +25,10 @@ namespace WixToolsetTest.Converters var expected = String.Join(Environment.NewLine, "", - " ", - " ", - " ", - " ", + " ", + " ", + " ", + " ", ""); var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); @@ -40,7 +40,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(7, errors); + Assert.Equal(11, errors); Assert.Equal(expected, actual); } diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs index 02a06cff..0266e177 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -15,7 +15,7 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs index 00ce8461..da4f5135 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -14,7 +14,7 @@ - + -- cgit v1.2.3-55-g6feb From 61cd9e6baeffa365ea535b09d3cf69731b989a9a Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Tue, 13 Oct 2020 18:59:30 -0400 Subject: Fix conversion of Product/@Condition. --- src/WixToolset.Converters/WixConverter.cs | 6 ++-- .../WixToolsetTest.Converters/ConditionFixture.cs | 38 ++++++++++++++++++++++ 2 files changed, 41 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index b82c4490..1fcaacb4 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -680,10 +680,10 @@ namespace WixToolset.Converters } } - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) + var xConditions = element.Elements(ConditionElementName).ToList(); + foreach (var xCondition in xConditions) { - var message = element.Attribute("Message")?.Value; + var message = xCondition.Attribute("Message")?.Value; if (!String.IsNullOrEmpty(message) && TryGetInnerText(xCondition, out var text) && diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 65fa6734..629fbd2a 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -213,6 +213,44 @@ namespace WixToolsetTest.Converters WixAssert.CompareLineByLine(expected, actualLines); } + [Fact] + public void FixLaunchConditionInProduct() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " 1<2", + " ", + " ", + " 1=2", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + [Fact] public void FixPermissionExCondition() { -- cgit v1.2.3-55-g6feb From 507d9da4116ef2211c466b9edffc4d1c23c79b9b Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Fri, 23 Oct 2020 17:48:34 -0400 Subject: Reorganize Product/Package to Package/SummaryInformation. --- src/WixToolset.Converters/WixConverter.cs | 111 ++++++++++- .../WixToolsetTest.Converters/ConditionFixture.cs | 8 +- .../ConverterIntegrationFixture.cs | 8 +- .../WixToolsetTest.Converters/ExtensionFixture.cs | 80 ++++++++ .../FirewallExtensionFixture.cs | 80 -------- .../ProductPackageFixture.cs | 209 +++++++++++++++++++++ .../PackageSummaryInformation/TypicalV3.msi | Bin 0 -> 32768 bytes .../PackageSummaryInformation/TypicalV3.wxs | 37 ++++ .../Preprocessor/ConvertedPreprocessor.wxs | 8 +- .../TestData/QtExec.bad/v4_expected.wxs | 8 +- .../TestData/QtExec/v4_expected.wxs | 8 +- .../TestData/SingleFile/ConvertedSingleFile.wxs | 8 +- .../WixToolsetTest.Converters.csproj | 2 + 13 files changed, 463 insertions(+), 104 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/ExtensionFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/ProductPackageFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi create mode 100644 src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 1fcaacb4..bfdaa31b 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -57,9 +57,11 @@ namespace WixToolset.Converters private static readonly XName LaunchElementName = WixNamespace + "Launch"; private static readonly XName LevelElementName = WixNamespace + "Level"; private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; + private static readonly XName ModuleElementName = WixNamespace + "Module"; private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; + private static readonly XName PackageElementName = WixNamespace + "Package"; private static readonly XName PayloadElementName = WixNamespace + "Payload"; private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; private static readonly XName ProductElementName = WixNamespace + "Product"; @@ -67,7 +69,6 @@ namespace WixToolset.Converters private static readonly XName PublishElementName = WixNamespace + "Publish"; private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; - private static readonly XName RowElementName = WixNamespace + "Row"; private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; @@ -86,6 +87,7 @@ namespace WixToolset.Converters private static readonly XName Include4ElementName = WixNamespace + "Include"; private static readonly XName Include3ElementName = Wix3Namespace + "Include"; private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; + private static readonly XName SummaryInformationElementName = WixNamespace + "SummaryInformation"; private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() { @@ -147,6 +149,7 @@ namespace WixToolset.Converters { WixConverter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, { WixConverter.ErrorElementName, this.ConvertErrorElement }, { WixConverter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.ModuleElementName, this.ConvertModuleElement }, { WixConverter.MsiPackageElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.MspPackageElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, @@ -669,6 +672,36 @@ namespace WixToolset.Converters private void ConvertProgressTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + private void ConvertModuleElement(XElement element) + { + if (element.Attribute("Guid") == null // skip already-converted Module elements + && this.OnError(ConverterTestType.ModuleAndPackageRenamed, element, "The Module and Package elements have been renamed and reorganized for simplicity.")) + { + var xModule = element; + + var xSummaryInformation = xModule.Element(PackageElementName); + if (xSummaryInformation != null) + { + xSummaryInformation.Name = SummaryInformationElementName; + + RemoveAttribute(xSummaryInformation, "AdminImage"); + RemoveAttribute(xSummaryInformation, "Comments"); + MoveAttribute(xSummaryInformation, "Id", xModule, "Guid"); + MoveAttribute(xSummaryInformation, "InstallerVersion", xModule); + RemoveAttribute(xSummaryInformation, "Languages"); + RemoveAttribute(xSummaryInformation, "Platform"); + RemoveAttribute(xSummaryInformation, "Platforms"); + RemoveAttribute(xSummaryInformation, "ReadOnly"); + MoveAttribute(xSummaryInformation, "SummaryCodepage", xSummaryInformation, "Codepage", defaultValue: "1252"); + + if (!xSummaryInformation.HasAttributes) + { + xSummaryInformation.Remove(); + } + } + } + } + private void ConvertProductElement(XElement element) { var id = element.Attribute("Id"); @@ -696,6 +729,72 @@ namespace WixToolset.Converters xCondition.Remove(); } } + + if (this.OnError(ConverterTestType.ProductAndPackageRenamed, element, "The Product and Package elements have been renamed and reorganized for simplicity.")) + { + var xPackage = element; + xPackage.Name = PackageElementName; + + var xSummaryInformation = xPackage.Element(PackageElementName); + if (xSummaryInformation != null) + { + xSummaryInformation.Name = SummaryInformationElementName; + + RemoveAttribute(xSummaryInformation, "AdminImage"); + RemoveAttribute(xSummaryInformation, "Comments"); + MoveAttribute(xSummaryInformation, "Compressed", xPackage); + RemoveAttribute(xSummaryInformation, "Id"); + MoveAttribute(xSummaryInformation, "InstallerVersion", xPackage, defaultValue: "500"); + MoveAttribute(xSummaryInformation, "InstallScope", xPackage, "Scope", defaultValue: "perMachine"); + RemoveAttribute(xSummaryInformation, "Platform"); + RemoveAttribute(xSummaryInformation, "Platforms"); + RemoveAttribute(xSummaryInformation, "ReadOnly"); + MoveAttribute(xSummaryInformation, "ShortNames", xPackage); + MoveAttribute(xSummaryInformation, "SummaryCodepage", xSummaryInformation, "Codepage", defaultValue: "1252"); + MoveAttribute(xPackage, "Id", xPackage, "ProductCode"); + + var xInstallPrivileges = xSummaryInformation.Attribute("InstallPrivileges"); + switch (xInstallPrivileges?.Value) + { + case "limited": + xPackage.SetAttributeValue("Scope", "perUser"); + break; + case "elevated": + { + var xAllUsers = xPackage.Elements(PropertyElementName).SingleOrDefault(p => p.Attribute("Id")?.Value == "ALLUSERS"); + if (xAllUsers?.Attribute("Value")?.Value == "1") + { + xAllUsers?.Remove(); + } + } + break; + } + + xInstallPrivileges?.Remove(); + + if (!xSummaryInformation.HasAttributes) + { + xSummaryInformation.Remove(); + } + } + } + } + + private static void MoveAttribute(XElement xSource, string attributeName, XElement xDestination, string destinationAttributeName = null, string defaultValue = null) + { + var xAttribute = xSource.Attribute(attributeName); + if (xAttribute != null && (defaultValue == null || xAttribute.Value != defaultValue)) + { + xDestination.SetAttributeValue(destinationAttributeName ?? attributeName, xAttribute.Value); + } + + xAttribute?.Remove(); + } + + private static void RemoveAttribute(XElement xSummaryInformation, string attributeName) + { + var xAttribute = xSummaryInformation.Attribute(attributeName); + xAttribute?.Remove(); } private void ConvertPublishElement(XElement element) @@ -1300,6 +1399,16 @@ namespace WixToolset.Converters /// The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef. /// CustomActionKeysAreNowRefs, + + /// + /// The Product and Package elements have been renamed and reorganized. + /// + ProductAndPackageRenamed, + + /// + /// The Module and Package elements have been renamed and reorganized. + /// + ModuleAndPackageRenamed, } } } diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 629fbd2a..75ceec31 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -220,6 +220,7 @@ namespace WixToolsetTest.Converters "", "", " ", + " ", " ", " 1<2", " ", @@ -232,10 +233,11 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", + " ", " ", " ", - " ", + " ", "" }; @@ -245,7 +247,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); + Assert.Equal(5, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index 09387590..38afca72 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -58,7 +58,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); - Assert.Equal(7, errors); + Assert.Equal(8, errors); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -84,7 +84,7 @@ namespace WixToolsetTest.Converters var settingsFile = Path.Combine(folder, "wixcop.settings.xml"); var result = RunConversion(targetFile, settingsFile: settingsFile); - Assert.Equal(7, result.ExitCode); + Assert.Equal(8, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -108,7 +108,7 @@ namespace WixToolsetTest.Converters File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); var result = RunConversion(targetFile); - Assert.Equal(11, result.ExitCode); + Assert.Equal(12, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -133,7 +133,7 @@ namespace WixToolsetTest.Converters var result = RunConversion(targetFile); - Assert.Equal(11, result.ExitCode); + Assert.Equal(12, result.ExitCode); Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); diff --git a/src/test/WixToolsetTest.Converters/ExtensionFixture.cs b/src/test/WixToolsetTest.Converters/ExtensionFixture.cs new file mode 100644 index 00000000..4bf2ed3d --- /dev/null +++ b/src/test/WixToolsetTest.Converters/ExtensionFixture.cs @@ -0,0 +1,80 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ExtensionFixture : BaseConverterFixture + { + [Fact] + public void FixRemoteAddressValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " 127.0.0.1", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixXmlConfigValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " a<>b", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs deleted file mode 100644 index e6ec8568..00000000 --- a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs +++ /dev/null @@ -1,80 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class FirewallExtensionFixture : BaseConverterFixture - { - [Fact] - public void FixRemoteAddressValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " 127.0.0.1", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixXmlConfigValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " a<>b", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs new file mode 100644 index 00000000..9407ff16 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs @@ -0,0 +1,209 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolset.Core.TestPackage; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ProductPackageFixture : BaseConverterFixture + { + [Fact] + public void FixesCompressed() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + private static void AssertSuccess(string input, int expectedErrorCount, string[] expected) + { + var document = XDocument.Parse(input, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(expectedErrorCount, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixesInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesDefaultInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesNonDefaultInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesLimitedInstallerPrivileges() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesElevatedInstallerPrivileges() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void CanDecompileAndRecompile() + { + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(); + var intermediateFolder = Path.Combine(baseFolder, "obj"); + var decompiledWxsPath = Path.Combine(baseFolder, "TypicalV3.wxs"); + + var folder = TestData.Get(@"TestData\PackageSummaryInformation"); + var v3msiPath = Path.Combine(folder, "TypicalV3.msi"); + var result = WixRunner.Execute(new[] + { + "decompile", v3msiPath, + "-intermediateFolder", intermediateFolder, + "-o", decompiledWxsPath + }); + + result.AssertSuccess(); + + var v4msiPath = Path.Combine(intermediateFolder, "TypicalV4.msi"); + result = WixRunner.Execute(new[] + { + "build", decompiledWxsPath, + "-arch", "x64", + "-intermediateFolder", intermediateFolder, + "-o", v4msiPath + }); + + result.AssertSuccess(); + + Assert.True(File.Exists(v4msiPath)); + + var v3results = Query.QueryDatabase(v3msiPath, new[] { "_SummaryInformation", "Property" }); + var v4results = Query.QueryDatabase(v4msiPath, new[] { "_SummaryInformation", "Property" }); + WixAssert.CompareLineByLine(v3results, v4results); + } + } + } +} diff --git a/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi b/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi new file mode 100644 index 00000000..0d7e1b21 Binary files /dev/null and b/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi differ diff --git a/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs b/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs new file mode 100644 index 00000000..8c5027b4 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs index ea52c71f..e601ae2a 100644 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -1,12 +1,12 @@ - + - - + + @@ -57,5 +57,5 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs index 0266e177..169eb07e 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -1,12 +1,12 @@ - + - - + + @@ -59,5 +59,5 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs index da4f5135..71df9fd9 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -1,12 +1,12 @@ - + - - + + @@ -58,5 +58,5 @@ - + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs index ec4d84d5..b52f5855 100644 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -1,12 +1,12 @@ - + - - + + @@ -55,5 +55,5 @@ - + diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 9f761738..b09b5418 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -23,6 +23,8 @@ + + -- cgit v1.2.3-55-g6feb From 7e1597b3d7600ed6d0437334e817b9202e6e8b30 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Mon, 26 Oct 2020 21:51:00 -0400 Subject: Clean up MediaTemplate and tweak a bit. --- src/WixToolset.Converters/FixupCommandBase.cs | 3 ++- src/WixToolset.Converters/WixConverter.cs | 15 ++++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/FixupCommandBase.cs b/src/WixToolset.Converters/FixupCommandBase.cs index 0f58fbdb..14edf97b 100644 --- a/src/WixToolset.Converters/FixupCommandBase.cs +++ b/src/WixToolset.Converters/FixupCommandBase.cs @@ -69,7 +69,7 @@ namespace WixToolset.Converters return true; case "n": - case "--dry-run": + case "-dry-run": this.DryRun = true; return true; @@ -81,6 +81,7 @@ namespace WixToolset.Converters case "s": case "r": case "-recurse": + case "-recursive": this.Recurse = true; return true; diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index bfdaa31b..ac63f26b 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -88,6 +88,7 @@ namespace WixToolset.Converters private static readonly XName Include3ElementName = Wix3Namespace + "Include"; private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; private static readonly XName SummaryInformationElementName = WixNamespace + "SummaryInformation"; + private static readonly XName MediaTemplateElementName = WixNamespace + "MediaTemplate"; private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() { @@ -730,6 +731,13 @@ namespace WixToolset.Converters } } + var xMediaTemplate = element.Element(MediaTemplateElementName); + if (xMediaTemplate?.HasAttributes == false + && this.OnError(ConverterTestType.DefaultMediaTemplate, element, "A MediaTemplate with no attributes set is now provided by default. Remove the element.")) + { + xMediaTemplate.Remove(); + } + if (this.OnError(ConverterTestType.ProductAndPackageRenamed, element, "The Product and Package elements have been renamed and reorganized for simplicity.")) { var xPackage = element; @@ -742,7 +750,7 @@ namespace WixToolset.Converters RemoveAttribute(xSummaryInformation, "AdminImage"); RemoveAttribute(xSummaryInformation, "Comments"); - MoveAttribute(xSummaryInformation, "Compressed", xPackage); + MoveAttribute(xSummaryInformation, "Compressed", xPackage, defaultValue: "no"); RemoveAttribute(xSummaryInformation, "Id"); MoveAttribute(xSummaryInformation, "InstallerVersion", xPackage, defaultValue: "500"); MoveAttribute(xSummaryInformation, "InstallScope", xPackage, "Scope", defaultValue: "perMachine"); @@ -1409,6 +1417,11 @@ namespace WixToolset.Converters /// The Module and Package elements have been renamed and reorganized. /// ModuleAndPackageRenamed, + + /// + /// A MediaTemplate with no attributes set is now provided by default. + /// + DefaultMediaTemplate, } } } -- cgit v1.2.3-55-g6feb From f48db8f05c4fa2ad8a67190db8c43cb2b364bd99 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Thu, 29 Oct 2020 20:56:49 -0400 Subject: Strong-name sign WiX assemblies. --- src/CSharp.Build.props | 11 +++++++++++ src/Directory.Build.props | 1 + src/wix.snk | Bin 0 -> 596 bytes 3 files changed, 12 insertions(+) create mode 100644 src/CSharp.Build.props create mode 100644 src/wix.snk (limited to 'src') diff --git a/src/CSharp.Build.props b/src/CSharp.Build.props new file mode 100644 index 00000000..b12f4c6e --- /dev/null +++ b/src/CSharp.Build.props @@ -0,0 +1,11 @@ + + + + + true + $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk)) + + diff --git a/src/Directory.Build.props b/src/Directory.Build.props index a22f4470..f83cc154 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -22,6 +22,7 @@ WiX Toolset + diff --git a/src/wix.snk b/src/wix.snk new file mode 100644 index 00000000..3908a66a Binary files /dev/null and b/src/wix.snk differ -- cgit v1.2.3-55-g6feb From 06b0b7b3e5504d062fc2226dd9a64dc4efa41f47 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sun, 1 Nov 2020 17:45:42 -0600 Subject: Add warnings for util:RegistrySearch (value) and DisplayInternalUI. --- src/WixToolset.Converters/WixConverter.cs | 38 +++++++++- .../WixToolsetTest.Converters/ExtensionFixture.cs | 80 ---------------------- .../FirewallExtensionFixture.cs | 47 +++++++++++++ .../UtilExtensionFixture.cs | 35 ++++++++++ 4 files changed, 118 insertions(+), 82 deletions(-) delete mode 100644 src/test/WixToolsetTest.Converters/ExtensionFixture.cs create mode 100644 src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index ac63f26b..c713045e 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -78,6 +78,7 @@ namespace WixToolset.Converters private static readonly XName VariableElementName = WixNamespace + "Variable"; private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; + private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; private static readonly XName PropertyElementName = WixNamespace + "Property"; @@ -151,8 +152,8 @@ namespace WixToolset.Converters { WixConverter.ErrorElementName, this.ConvertErrorElement }, { WixConverter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.ModuleElementName, this.ConvertModuleElement }, - { WixConverter.MsiPackageElementName, this.ConvertSuppressSignatureValidation }, - { WixConverter.MspPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.MsiPackageElementName, this.ConvertWindowsInstallerPackageElement }, + { WixConverter.MspPackageElementName, this.ConvertWindowsInstallerPackageElement }, { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.PayloadElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, @@ -171,6 +172,7 @@ namespace WixToolset.Converters { WixConverter.VariableElementName, this.ConvertVariableElement }, { WixConverter.UtilCloseApplicationElementName, this.ConvertUtilCloseApplicationElementName }, { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, + { WixConverter.UtilRegistrySearchName, this.ConvertUtilRegistrySearchElement }, { WixConverter.UtilXmlConfigElementName, this.ConvertUtilXmlConfigElement }, { WixConverter.PropertyElementName, this.ConvertPropertyElement }, { WixConverter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, @@ -863,6 +865,16 @@ namespace WixToolset.Converters private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertWindowsInstallerPackageElement(XElement element) + { + this.ConvertSuppressSignatureValidation(element); + + if (null != element.Attribute("DisplayInternalUI")) + { + this.OnError(ConverterTestType.DisplayInternalUiNotConvertable, element, "The DisplayInternalUI functionality has fundamentally changed and requires BootstrapperApplication support."); + } + } + private void ConvertCustomActionElement(XElement xCustomAction) { var xBinaryKey = xCustomAction.Attribute("BinaryKey"); @@ -986,6 +998,18 @@ namespace WixToolset.Converters } } + private void ConvertUtilRegistrySearchElement(XElement element) + { + if (this.SourceVersion < 4) + { + var result = element.Attribute("Result")?.Value; + if (result == null || result == "value") + { + this.OnError(ConverterTestType.UtilRegistryValueSearchBehaviorChange, element, "Breaking change: util:RegistrySearch for a value no longer clears the variable when the key or value is missing."); + } + } + } + private void ConvertUtilXmlConfigElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); /// @@ -1422,6 +1446,16 @@ namespace WixToolset.Converters /// A MediaTemplate with no attributes set is now provided by default. /// DefaultMediaTemplate, + + /// + /// util:RegistrySearch has breaking change when value is missing. + /// + UtilRegistryValueSearchBehaviorChange, + + /// + /// DisplayInternalUI can't be converted. + /// + DisplayInternalUiNotConvertable, } } } diff --git a/src/test/WixToolsetTest.Converters/ExtensionFixture.cs b/src/test/WixToolsetTest.Converters/ExtensionFixture.cs deleted file mode 100644 index 4bf2ed3d..00000000 --- a/src/test/WixToolsetTest.Converters/ExtensionFixture.cs +++ /dev/null @@ -1,80 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class ExtensionFixture : BaseConverterFixture - { - [Fact] - public void FixRemoteAddressValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " 127.0.0.1", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixXmlConfigValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " a<>b", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs new file mode 100644 index 00000000..f3437078 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs @@ -0,0 +1,47 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ExtensionFixture : BaseConverterFixture + { + [Fact] + public void FixRemoteAddressValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " 127.0.0.1", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs index 9d55af79..9964e3b0 100644 --- a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs +++ b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs @@ -76,5 +76,40 @@ namespace WixToolsetTest.Converters var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); } + + [Fact] + public void WarnsOnAllRegistryValueSearches() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } } } -- cgit v1.2.3-55-g6feb From 6a96c2ee082c37fd12d071514cab450f0c18618a Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Wed, 4 Nov 2020 19:10:55 -0500 Subject: Warn about new InstallerVersion default. --- src/WixToolset.Converters/WixConverter.cs | 17 +++++++++++++ .../WixToolsetTest.Converters/ConditionFixture.cs | 2 +- .../ProductPackageFixture.cs | 29 +++++++++++++++++++--- 3 files changed, 44 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c713045e..be09a683 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -687,6 +687,12 @@ namespace WixToolset.Converters { xSummaryInformation.Name = SummaryInformationElementName; + var xInstallerVersion = xSummaryInformation.Attribute("InstallerVersion"); + if (this.SourceVersion < 4 && xInstallerVersion == null) + { + this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Module element."); + } + RemoveAttribute(xSummaryInformation, "AdminImage"); RemoveAttribute(xSummaryInformation, "Comments"); MoveAttribute(xSummaryInformation, "Id", xModule, "Guid"); @@ -750,6 +756,12 @@ namespace WixToolset.Converters { xSummaryInformation.Name = SummaryInformationElementName; + var xInstallerVersion = xSummaryInformation.Attribute("InstallerVersion"); + if (this.SourceVersion < 4 && xInstallerVersion == null) + { + this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Package element."); + } + RemoveAttribute(xSummaryInformation, "AdminImage"); RemoveAttribute(xSummaryInformation, "Comments"); MoveAttribute(xSummaryInformation, "Compressed", xPackage, defaultValue: "no"); @@ -1456,6 +1468,11 @@ namespace WixToolset.Converters /// DisplayInternalUI can't be converted. /// DisplayInternalUiNotConvertable, + + /// + /// InstallerVersion has breaking change when missing. + /// + InstallerVersionBehaviorChange, } } } diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index 75ceec31..e5f33b04 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -247,7 +247,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); + Assert.Equal(6, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs index 9407ff16..94681a4c 100644 --- a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs +++ b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs @@ -33,7 +33,7 @@ namespace WixToolsetTest.Converters "" }; - AssertSuccess(parse, 3, expected); + AssertSuccess(parse, 4, expected); } private static void AssertSuccess(string input, int expectedErrorCount, string[] expected) @@ -96,6 +96,29 @@ namespace WixToolsetTest.Converters AssertSuccess(parse, 3, expected); } + [Fact] + public void FixesImplicitInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + [Fact] public void FixesNonDefaultInstallerVersion() { @@ -139,7 +162,7 @@ namespace WixToolsetTest.Converters "" }; - AssertSuccess(parse, 3, expected); + AssertSuccess(parse, 4, expected); } [Fact] @@ -164,7 +187,7 @@ namespace WixToolsetTest.Converters "" }; - AssertSuccess(parse, 3, expected); + AssertSuccess(parse, 4, expected); } [Fact] -- cgit v1.2.3-55-g6feb From d4a7583d9df4a3ac14f8c000802fb500b9948a29 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Mon, 9 Nov 2020 15:50:10 -0500 Subject: Warn about inability to convert Verb/@Target. --- src/WixToolset.Converters/WixConverter.cs | 16 +++++++++++++ .../WixToolsetTest.Converters/ConverterFixture.cs | 26 ++++++++++++++++++++++ 2 files changed, 42 insertions(+) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index be09a683..2100b22d 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -76,6 +76,7 @@ namespace WixToolset.Converters private static readonly XName TextElementName = WixNamespace + "Text"; private static readonly XName UITextElementName = WixNamespace + "UIText"; private static readonly XName VariableElementName = WixNamespace + "Variable"; + private static readonly XName VerbElementName = WixNamespace + "Verb"; private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; @@ -177,6 +178,7 @@ namespace WixToolset.Converters { WixConverter.PropertyElementName, this.ConvertPropertyElement }, { WixConverter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, { WixConverter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, + { WixConverter.VerbElementName, this.ConvertVerbElement }, }; this.Messaging = messaging; @@ -768,6 +770,7 @@ namespace WixToolset.Converters RemoveAttribute(xSummaryInformation, "Id"); MoveAttribute(xSummaryInformation, "InstallerVersion", xPackage, defaultValue: "500"); MoveAttribute(xSummaryInformation, "InstallScope", xPackage, "Scope", defaultValue: "perMachine"); + RemoveAttribute(xSummaryInformation, "Languages"); RemoveAttribute(xSummaryInformation, "Platform"); RemoveAttribute(xSummaryInformation, "Platforms"); RemoveAttribute(xSummaryInformation, "ReadOnly"); @@ -887,6 +890,14 @@ namespace WixToolset.Converters } } + private void ConvertVerbElement(XElement element) + { + if (null != element.Attribute("Target")) + { + this.OnError(ConverterTestType.VerbTargetNotConvertable, element, "The Verb/@Target attribute has been replaced with typed @TargetFile and @TargetProperty attributes."); + } + } + private void ConvertCustomActionElement(XElement xCustomAction) { var xBinaryKey = xCustomAction.Attribute("BinaryKey"); @@ -1473,6 +1484,11 @@ namespace WixToolset.Converters /// InstallerVersion has breaking change when missing. /// InstallerVersionBehaviorChange, + + /// + /// Verb/@Target can't be converted. + /// + VerbTargetNotConvertable, } } } diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 29f34412..c74ef121 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -355,5 +355,31 @@ namespace WixToolsetTest.Converters Assert.Equal(1, errors); Assert.Equal(expected, actual); } + + [Fact] + public void CantConvertVerbTarget() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } } } -- cgit v1.2.3-55-g6feb From 05cafee83e597badaf842bd7e6ba06f4d8fe193f Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Tue, 8 Dec 2020 15:14:40 -0600 Subject: Add conversion for BootstrapperApplicationDll and bal:UseUILanguages. --- .../WixToolset.Converters.Symbolizer.csproj | 2 +- src/WixToolset.Converters/WixConverter.cs | 97 +++++++++++++- .../WixToolset.Converters.csproj | 2 +- .../BootstrapperApplicationFixture.cs | 144 ++++++++++++++++++++- 4 files changed, 237 insertions(+), 8 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj index f0ea99c6..1d4f09dd 100644 --- a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj +++ b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj @@ -30,6 +30,6 @@ - + diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 2100b22d..c83ef551 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -31,6 +31,7 @@ namespace WixToolset.Converters private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; + private static readonly XNamespace WixBalNamespace = "http://wixtoolset.org/schemas/v4/wxs/bal"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall"; @@ -40,6 +41,7 @@ namespace WixToolset.Converters private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication"; + private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; private static readonly XName ColumnElementName = WixNamespace + "Column"; private static readonly XName ComponentElementName = WixNamespace + "Component"; @@ -77,6 +79,7 @@ namespace WixToolset.Converters private static readonly XName UITextElementName = WixNamespace + "UIText"; private static readonly XName VariableElementName = WixNamespace + "Variable"; private static readonly XName VerbElementName = WixNamespace + "Verb"; + private static readonly XName BalUseUILanguagesName = WixBalNamespace + "UseUILanguages"; private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; @@ -453,10 +456,83 @@ namespace WixToolset.Converters private void ConvertBootstrapperApplicationElement(XElement element) { - if (this.SourceVersion < 4 && null == element.Attribute("DpiAwareness") && - this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplication DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default")) + var xUseUILanguages = element.Attribute(BalUseUILanguagesName); + if (xUseUILanguages != null && + this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior.")) { - element.Add(new XAttribute("DpiAwareness", "unaware")); + xUseUILanguages.Remove(); + } + + var xBADll = element.Elements(BootstrapperApplicationDllElementName).FirstOrDefault(); + if (xBADll == null) + { + xBADll = this.CreateBootstrapperApplicationDllElement(element); + + if (xBADll != null) + { + element.Add(Environment.NewLine); + element.Add(xBADll); + element.Add(Environment.NewLine); + } + } + } + + private XElement CreateBootstrapperApplicationDllElement(XElement element) + { + XElement xBADll = null; + var xSource = element.Attribute("SourceFile"); + var xDpiAwareness = element.Attribute("DpiAwareness"); + + if (xSource != null) + { + if (xBADll != null || CreateBADllElement(element, out xBADll)) + { + MoveAttribute(element, "SourceFile", xBADll); + MoveAttribute(element, "Name", xBADll); + } + } + else if (xDpiAwareness != null || this.SourceVersion < 4) // older code might be relying on old behavior of first Payload element being the BA dll. + { + var xFirstChild = element.Elements().FirstOrDefault(); + if (xFirstChild?.Name == PayloadElementName) + { + if (xBADll != null || CreateBADllElement(element, out xBADll)) + { + var attributes = xFirstChild.Attributes().ToList(); + xFirstChild.Remove(); + + foreach (var attribute in attributes) + { + xBADll.Add(attribute); + } + } + } + else + { + this.OnError(ConverterTestType.BootstrapperApplicationDllRequired, element, "The new BootstrapperApplicationDll element is required but could not be added automatically since the bootstrapper application dll was not directly specified."); + } + } + + if (xDpiAwareness != null) + { + if (xBADll != null || CreateBADllElement(element, out xBADll)) + { + MoveAttribute(element, "DpiAwareness", xBADll); + } + } + else if (this.SourceVersion < 4 && xBADll != null && + this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplicationDll DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default")) + { + xBADll.Add(new XAttribute("DpiAwareness", "unaware")); + } + + return xBADll; + + bool CreateBADllElement(XObject node, out XElement xCreatedBADll) + { + var create = this.OnError(ConverterTestType.BootstrapperApplicationDll, node, "The bootstrapper application dll is now specified in the BootstrapperApplicationDll element."); + xCreatedBADll = create ? new XElement(BootstrapperApplicationDllElementName) : null; + return create; } } @@ -1489,6 +1565,21 @@ namespace WixToolset.Converters /// Verb/@Target can't be converted. /// VerbTargetNotConvertable, + + /// + /// The bootstrapper application dll is now specified in its own element. + /// + BootstrapperApplicationDll, + + /// + /// The new bootstrapper application dll element is required. + /// + BootstrapperApplicationDllRequired, + + /// + /// bal:UseUILanguages is deprecated, 'true' is now the standard behavior. + /// + BalUseUILanguagesDeprecated, } } } diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj index 424a393b..46eb54ea 100644 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -22,6 +22,6 @@ - + diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs index 68a8afc8..dc5bae00 100644 --- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs +++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -12,12 +12,14 @@ namespace WixToolsetTest.Converters public class BootstrapperApplicationFixture : BaseConverterFixture { [Fact] - public void SetsDpiUnawareFromV3() + public void CantCreateBootstrapperApplicationDllFromV3PayloadGroupRef() { var parse = String.Join(Environment.NewLine, "", " ", - " ", + " ", + " ", + " ", " ", ""); @@ -25,7 +27,9 @@ namespace WixToolsetTest.Converters { "", " ", - " ", + " ", + " ", + " ", " ", "" }; @@ -42,6 +46,76 @@ namespace WixToolsetTest.Converters WixAssert.CompareLineByLine(expected, actualLines); } + [Fact] + public void CreateBootstrapperApplicationDllFromV3() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CreateBootstrapperApplicationDllFromV3Payload() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + [Fact] public void DoesntSetDpiUnawareFromV4() { @@ -72,5 +146,69 @@ namespace WixToolsetTest.Converters var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); } + + [Fact] + public void KeepsDpiAwarenessFromV4() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void RemovesBalUseUILanguages() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } } } -- cgit v1.2.3-55-g6feb From 7378de4301d4f8c2570b29268ca7affbdb5721c2 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Tue, 8 Dec 2020 21:35:15 -0600 Subject: Add conversion for built-in BA usage from BootstrapperApplicationRef. --- src/WixToolset.Converters/WixConverter.cs | 110 +++++++++++ .../BootstrapperApplicationFixture.cs | 204 +++++++++++++++++++++ 2 files changed, 314 insertions(+) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c83ef551..ecd8b4e8 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -42,6 +42,7 @@ namespace WixToolset.Converters private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication"; private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; + private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef"; private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; private static readonly XName ColumnElementName = WixNamespace + "Column"; private static readonly XName ComponentElementName = WixNamespace + "Component"; @@ -80,6 +81,10 @@ namespace WixToolset.Converters private static readonly XName VariableElementName = WixNamespace + "Variable"; private static readonly XName VerbElementName = WixNamespace + "Verb"; private static readonly XName BalUseUILanguagesName = WixBalNamespace + "UseUILanguages"; + private static readonly XName BalStandardBootstrapperApplicationName = WixBalNamespace + "WixStandardBootstrapperApplication"; + private static readonly XName BalManagedBootstrapperApplicationHostName = WixBalNamespace + "WixManagedBootstrapperApplicationHost"; + private static readonly XName BalOldDotNetCoreBootstrapperApplicationName = WixBalNamespace + "WixDotNetCoreBootstrapperApplication"; + private static readonly XName BalNewDotNetCoreBootstrapperApplicationName = WixBalNamespace + "WixDotNetCoreBootstrapperApplicationHost"; private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; @@ -142,6 +147,7 @@ namespace WixToolset.Converters { WixConverter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement }, + { WixConverter.BootstrapperApplicationRefElementName, this.ConvertBootstrapperApplicationRefElement }, { WixConverter.ColumnElementName, this.ConvertColumnElement }, { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, { WixConverter.ControlElementName, this.ConvertControlElement }, @@ -536,6 +542,105 @@ namespace WixToolset.Converters } } + private void ConvertBootstrapperApplicationRefElement(XElement element) + { + var xUseUILanguages = element.Attribute(BalUseUILanguagesName); + if (xUseUILanguages != null && + this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior.")) + { + xUseUILanguages.Remove(); + } + + var xId = element.Attribute("Id"); + if (xId != null) + { + XName balBAName = null; + XName oldBalBAName = null; + string theme = null; + + switch (xId.Value) + { + case "WixStandardBootstrapperApplication.RtfLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "rtfLicense"; + break; + case "WixStandardBootstrapperApplication.RtfLargeLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "rtfLargeLicense"; + break; + case "WixStandardBootstrapperApplication.HyperlinkLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "hyperlinkLicense"; + break; + case "WixStandardBootstrapperApplication.HyperlinkLargeLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "hyperlinkLargeLicense"; + break; + case "WixStandardBootstrapperApplication.HyperlinkSidebarLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "hyperlinkSidebarLicense"; + break; + case "WixStandardBootstrapperApplication.Foundation": + balBAName = BalStandardBootstrapperApplicationName; + theme = "none"; + break; + case "ManagedBootstrapperApplicationHost": + case "ManagedBootstrapperApplicationHost.RtfLicense": + balBAName = BalManagedBootstrapperApplicationHostName; + theme = "standard"; + break; + case "ManagedBootstrapperApplicationHost.Minimal": + case "ManagedBootstrapperApplicationHost.RtfLicense.Minimal": + case "ManagedBootstrapperApplicationHost.Foundation": + balBAName = BalManagedBootstrapperApplicationHostName; + theme = "none"; + break; + case "DotNetCoreBootstrapperApplicationHost": + case "DotNetCoreBootstrapperApplicationHost.RtfLicense": + balBAName = BalNewDotNetCoreBootstrapperApplicationName; + oldBalBAName = BalOldDotNetCoreBootstrapperApplicationName; + theme = "standard"; + break; + case "DotNetCoreBootstrapperApplicationHost.Minimal": + case "DotNetCoreBootstrapperApplicationHost.RtfLicense.Minimal": + case "DotNetCoreBootstrapperApplicationHost.Foundation": + balBAName = BalNewDotNetCoreBootstrapperApplicationName; + oldBalBAName = BalOldDotNetCoreBootstrapperApplicationName; + theme = "none"; + break; + } + + if (balBAName != null && theme != null && + this.OnError(ConverterTestType.BalBootstrapperApplicationRefToElement, element, "Built-in bootstrapper applications must be referenced through their custom element")) + { + element.Name = BootstrapperApplicationElementName; + xId.Remove(); + this.ConvertBalBootstrapperApplicationRef(element, theme, balBAName, oldBalBAName); + } + } + } + + private void ConvertBalBootstrapperApplicationRef(XElement element, string theme, XName balBAElementName, XName oldBalBAElementName = null) + { + var xBalBa = element.Element(oldBalBAElementName ?? balBAElementName); + if (xBalBa == null) + { + xBalBa = new XElement(balBAElementName); + element.Add(Environment.NewLine); + element.Add(xBalBa); + element.Add(Environment.NewLine); + } + else if (oldBalBAElementName != null) + { + xBalBa.Name = BalNewDotNetCoreBootstrapperApplicationName; + } + + if (theme != "standard") + { + xBalBa.Add(new XAttribute("Theme", theme)); + } + } + private void ConvertColumnElement(XElement element) { var category = element.Attribute("Category"); @@ -1580,6 +1685,11 @@ namespace WixToolset.Converters /// bal:UseUILanguages is deprecated, 'true' is now the standard behavior. /// BalUseUILanguagesDeprecated, + + /// + /// The custom elements for built-in BAs are now required. + /// + BalBootstrapperApplicationRefToElement, } } } diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs index dc5bae00..60386470 100644 --- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs +++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -46,6 +46,210 @@ namespace WixToolsetTest.Converters WixAssert.CompareLineByLine(expected, actualLines); } + [Fact] + public void ConvertDotNetCoreBootstrapperApplicationRefWithExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertDotNetCoreBootstrapperApplicationRefWithoutExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertFrameworkBootstrapperApplicationRefWithExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertFrameworkBootstrapperApplicationRefWithoutExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertStandardBootstrapperApplicationRefWithExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertStandardBootstrapperApplicationRefWithoutExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + [Fact] public void CreateBootstrapperApplicationDllFromV3() { -- cgit v1.2.3-55-g6feb From 6bc164316666addde26feeec2d521b797de50dbb Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sat, 19 Dec 2020 00:04:24 -0600 Subject: Enable XML doc and run tests in appveyor.cmd. --- appveyor.cmd | 6 +++--- appveyor.yml | 2 ++ nuget.config | 1 + src/CSharp.Build.props | 2 ++ src/Directory.Build.targets | 8 ++++++++ src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs | 2 ++ .../WixToolset.Converters.Symbolizer.csproj | 5 +---- src/WixToolset.Converters/FixupCommandBase.cs | 2 ++ src/WixToolset.Converters/WixConverter.cs | 3 ++- src/WixToolset.Converters/WixToolset.Converters.csproj | 5 +---- .../WixToolsetCoreServiceProviderExtensions.cs | 8 ++++++++ .../WixToolsetTest.Converters/WixToolsetTest.Converters.csproj | 6 ++---- 12 files changed, 34 insertions(+), 16 deletions(-) (limited to 'src') diff --git a/appveyor.cmd b/appveyor.cmd index 1b0040a3..27d5eaec 100644 --- a/appveyor.cmd +++ b/appveyor.cmd @@ -2,11 +2,11 @@ @pushd %~dp0 @set _P=%~dp0build\Release\publish +dotnet test -c Release src\test\WixToolsetTest.Converters || exit /b +dotnet test -c Release src\test\WixToolsetTest.Converters.Symbolizer || exit /b + dotnet pack -c Release src\WixToolset.Converters || exit /b dotnet pack -c Release src\WixToolset.Converters.Symbolizer || exit /b -dotnet build -c Release src\test\WixToolsetTest.Converters || exit /b -dotnet build -c Release src\test\WixToolsetTest.Converters.Symbolizer || exit /b - @popd @endlocal diff --git a/appveyor.yml b/appveyor.yml index 522e5af3..f602d07c 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -21,6 +21,8 @@ environment: build_script: - appveyor.cmd +test: off + pull_requests: do_not_increment_build_number: true diff --git a/nuget.config b/nuget.config index e8a0cc92..31435a21 100644 --- a/nuget.config +++ b/nuget.config @@ -2,6 +2,7 @@ + diff --git a/src/CSharp.Build.props b/src/CSharp.Build.props index b12f4c6e..81d24ad1 100644 --- a/src/CSharp.Build.props +++ b/src/CSharp.Build.props @@ -5,7 +5,9 @@ --> + true true $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk)) + false diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index dac7452a..cb988931 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -9,6 +9,11 @@ See the original here: https://github.com/dotnet/sdk/issues/1151#issuecomment-385133284 --> + + false + $(OutputPath)\$(AssemblyName).xml + + true $(SolutionPath) @@ -45,4 +50,7 @@ + + + diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index 4fb891f9..92e247e5 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -10,6 +10,7 @@ namespace WixToolset.Converters.Symbolizer using WixToolset.Data.WindowsInstaller; using Wix3 = Microsoft.Tools.WindowsInstallerXml; +#pragma warning disable 1591 // TODO: add documentation public static class ConvertSymbols { public static Intermediate ConvertFile(string path) @@ -19,6 +20,7 @@ namespace WixToolset.Converters.Symbolizer } public static Intermediate ConvertOutput(Wix3.Output output) +#pragma warning restore 1591 { var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); diff --git a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj index 1d4f09dd..445c3500 100644 --- a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj +++ b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj @@ -10,10 +10,7 @@ WiX Toolset Converters Tuplizer embedded true - - - - NU1701 + true diff --git a/src/WixToolset.Converters/FixupCommandBase.cs b/src/WixToolset.Converters/FixupCommandBase.cs index 14edf97b..51256f5c 100644 --- a/src/WixToolset.Converters/FixupCommandBase.cs +++ b/src/WixToolset.Converters/FixupCommandBase.cs @@ -150,7 +150,9 @@ namespace WixToolset.Converters /// /// Inspect sub-directories. /// + /// /// The directory whose sub-directories will be inspected. + /// /// The number of errors that were found. private int InspectSubDirectories(Func inspector, string directory, CancellationToken cancellationToken) { diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index ecd8b4e8..d0c40050 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -17,7 +17,7 @@ namespace WixToolset.Converters /// /// WiX source code converter. /// - public class WixConverter + public sealed class WixConverter { private enum ConvertOperation { @@ -134,6 +134,7 @@ namespace WixToolset.Converters /// /// Instantiate a new Converter class. /// + /// /// Indentation value to use when validating leading whitespace. /// Test errors to display as warnings. /// Test errors to ignore. diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj index 46eb54ea..7dddefa5 100644 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ b/src/WixToolset.Converters/WixToolset.Converters.csproj @@ -10,10 +10,7 @@ WiX Toolset Converters embedded true - - - - NU1701 + true diff --git a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs index c5b7a27d..084d3b92 100644 --- a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs +++ b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs @@ -4,8 +4,16 @@ namespace WixToolset.Converters { using WixToolset.Extensibility.Services; + /// + /// Extension methods for adding Converters services. + /// public static class WixToolsetCoreServiceProviderExtensions { + /// + /// Adds Converters services. + /// + /// + /// public static IWixToolsetCoreServiceProvider AddConverter(this IWixToolsetCoreServiceProvider coreProvider) { var extensionManager = coreProvider.GetService(); diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index b09b5418..1bf44dbc 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -7,10 +7,6 @@ false - - NU1701 - - @@ -34,7 +30,9 @@ + + -- cgit v1.2.3-55-g6feb From 0f51c342c84d291fcb1c7cbde3a1613edbda300a Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 8 Jan 2021 14:32:36 -0800 Subject: Report invalid command line arguments as errors Also fixes wixtoolset/issues#6313 --- src/WixToolset.Converters/FixupCommandBase.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters/FixupCommandBase.cs b/src/WixToolset.Converters/FixupCommandBase.cs index 51256f5c..7ecce543 100644 --- a/src/WixToolset.Converters/FixupCommandBase.cs +++ b/src/WixToolset.Converters/FixupCommandBase.cs @@ -104,7 +104,7 @@ namespace WixToolset.Converters } catch { - parser.ErrorArgument = parameter; // $"Invalid numeric argument: {parameter}"; + parser.ReportErrorArgument(parameter); // $"Invalid numeric argument: {parameter}"; } return true; } -- cgit v1.2.3-55-g6feb From 2accc355d9dadb2688cf226f8736232d583281aa Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 8 Jan 2021 15:33:32 -0800 Subject: Rename ExePackage/@XxxCommand attributes to @XxxArguments Fixes wixtoolset/issues#6245 --- src/WixToolset.Converters/WixConverter.cs | 25 ++++++++++- .../WixToolsetTest.Converters/ExePackageFixture.cs | 49 ++++++++++++++++++++++ .../WixToolsetTest.Converters.csproj | 4 +- 3 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/ExePackageFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index d0c40050..a7f08b88 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -161,7 +161,7 @@ namespace WixToolset.Converters { WixConverter.FirewallRemoteAddressElementName, this.ConvertFirewallRemoteAddressElement }, { WixConverter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, { WixConverter.ErrorElementName, this.ConvertErrorElement }, - { WixConverter.ExePackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.ExePackageElementName, this.ConvertExePackageElement }, { WixConverter.ModuleElementName, this.ConvertModuleElement }, { WixConverter.MsiPackageElementName, this.ConvertWindowsInstallerPackageElement }, { WixConverter.MspPackageElementName, this.ConvertWindowsInstallerPackageElement }, @@ -843,6 +843,24 @@ namespace WixToolset.Converters private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + private void ConvertExePackageElement(XElement element) + { + this.ConvertSuppressSignatureValidation(element); + + foreach (var attributeName in new[] { "InstallCommand", "RepairCommand", "UninstallCommand" }) + { + var newName = attributeName.Replace("Command", "Arguments"); + var attribute = element.Attribute(attributeName); + + if (attribute != null && + this.OnError(ConverterTestType.RenameExePackageCommandToArguments, element, "The {0} element {1} attribute has been renamed {2}.", element.Name.LocalName, attribute.Name.LocalName, newName)) + { + element.Add(new XAttribute(newName, attribute.Value)); + attribute.Remove(); + } + } + } + private void ConvertPermissionExElement(XElement element) { var xCondition = element.Element(ConditionElementName); @@ -1691,6 +1709,11 @@ namespace WixToolset.Converters /// The custom elements for built-in BAs are now required. /// BalBootstrapperApplicationRefToElement, + + /// + /// The ExePackage elements "XxxCommand" attributes have been renamed to "XxxArguments". + /// + RenameExePackageCommandToArguments, } } } diff --git a/src/test/WixToolsetTest.Converters/ExePackageFixture.cs b/src/test/WixToolsetTest.Converters/ExePackageFixture.cs new file mode 100644 index 00000000..0ee8d065 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/ExePackageFixture.cs @@ -0,0 +1,49 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ExePackageFixture : BaseConverterFixture + { + [Fact] + public void CanConvertExePackageCommandToArguments() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 1bf44dbc..902494a2 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -36,8 +36,8 @@ - + - + -- cgit v1.2.3-55-g6feb From 8e60e672e42202589f8827c06a69970b330d8d81 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Thu, 28 Jan 2021 20:40:46 -0500 Subject: Fix Package/@Compressed for new (compressed) default. --- src/WixToolset.Converters/WixConverter.cs | 10 +++- .../WixToolsetTest.Converters/ConditionFixture.cs | 2 +- .../ProductPackageFixture.cs | 62 +++++++++++++++++++--- .../Preprocessor/ConvertedPreprocessor.wxs | 4 +- .../TestData/QtExec.bad/v4_expected.wxs | 4 +- .../TestData/QtExec/v4_expected.wxs | 4 +- .../TestData/SingleFile/ConvertedSingleFile.wxs | 4 +- 7 files changed, 72 insertions(+), 18 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index a7f08b88..c78e2245 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -964,9 +964,17 @@ namespace WixToolset.Converters this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Package element."); } + if (xSummaryInformation.Attribute("Compressed") == null) + { + xPackage.SetAttributeValue("Compressed", "no"); + } + else + { + MoveAttribute(xSummaryInformation, "Compressed", xPackage, defaultValue: "yes"); + } + RemoveAttribute(xSummaryInformation, "AdminImage"); RemoveAttribute(xSummaryInformation, "Comments"); - MoveAttribute(xSummaryInformation, "Compressed", xPackage, defaultValue: "no"); RemoveAttribute(xSummaryInformation, "Id"); MoveAttribute(xSummaryInformation, "InstallerVersion", xPackage, defaultValue: "500"); MoveAttribute(xSummaryInformation, "InstallScope", xPackage, "Scope", defaultValue: "perMachine"); diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs index e5f33b04..d3f65aeb 100644 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -233,7 +233,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", " ", diff --git a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs index 94681a4c..e01b9789 100644 --- a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs +++ b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs @@ -14,7 +14,7 @@ namespace WixToolsetTest.Converters public class ProductPackageFixture : BaseConverterFixture { [Fact] - public void FixesCompressed() + public void FixesCompressedWhenYes() { var parse = String.Join(Environment.NewLine, "", @@ -27,7 +27,53 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void FixesCompressedWhenNo() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void FixesCompressedWhenOmitted() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", " ", " ", "" @@ -64,7 +110,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", "" @@ -87,7 +133,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", "" @@ -110,7 +156,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", "" @@ -133,7 +179,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", "" @@ -156,7 +202,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", "" @@ -180,7 +226,7 @@ namespace WixToolsetTest.Converters var expected = new[] { "", - " ", + " ", " ", " ", " ", diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs index e601ae2a..b2302b4c 100644 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -1,11 +1,11 @@ - + - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs index 169eb07e..f26b5d1a 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -1,11 +1,11 @@ - + - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs index 71df9fd9..f5a02e2b 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -1,11 +1,11 @@ - + - + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs index b52f5855..9a83c237 100644 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -1,11 +1,11 @@ - + - + -- cgit v1.2.3-55-g6feb From bf5c60ffc7488fc9eb12b7104ba7d567f11cc85e Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Sun, 31 Jan 2021 19:33:26 -0500 Subject: Remove Burn Authenticode Fixes https://github.com/wixtoolset/issues/issues/6301 --- src/WixToolset.Converters/WixConverter.cs | 42 +++++++++++---- .../WixToolsetTest.Converters/ConverterFixture.cs | 61 +++++++++++++++++++++- 2 files changed, 91 insertions(+), 12 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c78e2245..be3e6b70 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -44,6 +44,7 @@ namespace WixToolset.Converters private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef"; private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; + private static readonly XName CatalogElementName = WixNamespace + "Catalog"; private static readonly XName ColumnElementName = WixNamespace + "Column"; private static readonly XName ComponentElementName = WixNamespace + "Component"; private static readonly XName ControlElementName = WixNamespace + "Control"; @@ -71,6 +72,7 @@ namespace WixToolset.Converters private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; private static readonly XName PublishElementName = WixNamespace + "Publish"; private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; + private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; @@ -149,6 +151,7 @@ namespace WixToolset.Converters { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement }, { WixConverter.BootstrapperApplicationRefElementName, this.ConvertBootstrapperApplicationRefElement }, + { WixConverter.CatalogElementName, this.ConvertCatalogElement }, { WixConverter.ColumnElementName, this.ConvertColumnElement }, { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, { WixConverter.ControlElementName, this.ConvertControlElement }, @@ -172,6 +175,7 @@ namespace WixToolset.Converters { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, { WixConverter.PublishElementName, this.ConvertPublishElement }, { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, + { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, @@ -642,6 +646,14 @@ namespace WixToolset.Converters } } + private void ConvertCatalogElement(XElement element) + { + if (this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The Catalog element is obsolete. Signature validation is no longer supported. The elkement will be removed.")) + { + element.Remove(); + } + } + private void ConvertColumnElement(XElement element) { var category = element.Attribute("Category"); @@ -1044,6 +1056,21 @@ namespace WixToolset.Converters private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertRemotePayloadElement(XElement element) + { + RemoveIfPresent(element.Attribute("CertificatePublicKey")); + RemoveIfPresent(element.Attribute("CertificateThumbprint")); + + void RemoveIfPresent(XAttribute xAttribute) + { + if (null != xAttribute + && this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The chain package element contains obsolete '{0}' attribute. Signature validation is no longer supported. The attribute will be removed.", xAttribute.Name)) + { + xAttribute.Remove(); + } + } + } + private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); @@ -1070,16 +1097,9 @@ namespace WixToolset.Converters { var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); - if (null != suppressSignatureValidation) + if (null != suppressSignatureValidation + && this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The chain package element contains obsolete '{0}' attribute. Signature validation is no longer supported. The attribute will be removed.", suppressSignatureValidation.Name)) { - if (this.OnError(ConverterTestType.SuppressSignatureValidationDeprecated, element, "The chain package element contains deprecated '{0}' attribute. Use the 'EnableSignatureValidation' attribute instead.", suppressSignatureValidation.Name)) - { - if ("no" == suppressSignatureValidation.Value) - { - element.Add(new XAttribute("EnableSignatureValidation", "yes")); - } - } - suppressSignatureValidation.Remove(); } } @@ -1579,9 +1599,9 @@ namespace WixToolset.Converters AssignAnonymousFileId, /// - /// SuppressSignatureValidation attribute is deprecated and replaced with EnableSignatureValidation. + /// SuppressSignatureValidation attribute is obsolete and corresponding functionality removed. /// - SuppressSignatureValidationDeprecated, + BundleSignatureValidationObsolete, /// /// WixCA Binary/@Id has been renamed to UtilCA. diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index c74ef121..20f42068 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -304,6 +304,65 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } + [Fact] + public void CanConvertCatalogElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertRemotePayloadElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + [Fact] public void CanConvertSuppressSignatureValidationNo() { @@ -314,7 +373,7 @@ namespace WixToolsetTest.Converters var expected = String.Join(Environment.NewLine, "", - " ", + " ", ""); var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); -- cgit v1.2.3-55-g6feb From 1a170f2a5afce8e4beb0100229e3c420629b7c88 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Sun, 31 Jan 2021 21:35:23 -0500 Subject: Address code-review comments. --- src/WixToolset.Converters/WixConverter.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index be3e6b70..73daa9a2 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -648,7 +648,7 @@ namespace WixToolset.Converters private void ConvertCatalogElement(XElement element) { - if (this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The Catalog element is obsolete. Signature validation is no longer supported. The elkement will be removed.")) + if (this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The Catalog element is obsolete. Signature validation is no longer supported. The element will be removed.")) { element.Remove(); } -- cgit v1.2.3-55-g6feb From 7ff5ffb753fc0f576c24b0faa5d03b6d85b0f238 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Thu, 11 Feb 2021 13:45:11 -0800 Subject: Replace Win64 attribute with Bitness attribute --- src/WixToolset.Converters/WixConverter.cs | 55 ++++++- .../WixToolsetTest.Converters/BitnessFixture.cs | 181 +++++++++++++++++++++ 2 files changed, 235 insertions(+), 1 deletion(-) create mode 100644 src/test/WixToolsetTest.Converters/BitnessFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 73daa9a2..18cd7115 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -43,6 +43,7 @@ namespace WixToolset.Converters private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication"; private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef"; + private static readonly XName ApprovedExeForElevationElementName = WixNamespace + "ApprovedExeForElevation"; private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; private static readonly XName CatalogElementName = WixNamespace + "Catalog"; private static readonly XName ColumnElementName = WixNamespace + "Column"; @@ -73,6 +74,7 @@ namespace WixToolset.Converters private static readonly XName PublishElementName = WixNamespace + "Publish"; private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; + private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; @@ -151,6 +153,7 @@ namespace WixToolset.Converters { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement }, { WixConverter.BootstrapperApplicationRefElementName, this.ConvertBootstrapperApplicationRefElement }, + { WixConverter.ApprovedExeForElevationElementName, this.ConvertApprovedExeForElevationElement }, { WixConverter.CatalogElementName, this.ConvertCatalogElement }, { WixConverter.ColumnElementName, this.ConvertColumnElement }, { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, @@ -175,6 +178,7 @@ namespace WixToolset.Converters { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, { WixConverter.PublishElementName, this.ConvertPublishElement }, { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, + { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement }, { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, @@ -625,6 +629,20 @@ namespace WixToolset.Converters } } + private void ConvertApprovedExeForElevationElement(XElement element) + { + if (this.SourceVersion < 4) + { + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) + { + var value = win64.Value; + element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + win64.Remove(); + } + } + } + private void ConvertBalBootstrapperApplicationRef(XElement element, string theme, XName balBAElementName, XName oldBalBAElementName = null) { var xBalBa = element.Element(oldBalBAElementName ?? balBAElementName); @@ -733,6 +751,14 @@ namespace WixToolset.Converters xCondition.Remove(); } } + + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) + { + var value = win64.Value; + element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + win64.Remove(); + } } private void ConvertDirectoryElement(XElement element) @@ -1071,6 +1097,20 @@ namespace WixToolset.Converters } } + private void ConvertRegistrySearchElement(XElement element) + { + if (this.SourceVersion < 4) + { + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) + { + var value = win64.Value; + element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + win64.Remove(); + } + } + } + private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); @@ -1241,7 +1281,7 @@ namespace WixToolset.Converters var inheritable = element.Parent.Name == CreateFolderElementName; if (!inheritable) { - if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default")) + if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default.")) { element.Add(new XAttribute("Inheritable", "no")); } @@ -1253,6 +1293,14 @@ namespace WixToolset.Converters { if (this.SourceVersion < 4) { + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) + { + var value = win64.Value; + element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + win64.Remove(); + } + var result = element.Attribute("Result")?.Value; if (result == null || result == "value") { @@ -1742,6 +1790,11 @@ namespace WixToolset.Converters /// The ExePackage elements "XxxCommand" attributes have been renamed to "XxxArguments". /// RenameExePackageCommandToArguments, + + /// + /// The Win64 attribute has been renamed. Use the Bitness attribute instead. + /// + Win64AttributeRenamed, } } } diff --git a/src/test/WixToolsetTest.Converters/BitnessFixture.cs b/src/test/WixToolsetTest.Converters/BitnessFixture.cs new file mode 100644 index 00000000..9996806d --- /dev/null +++ b/src/test/WixToolsetTest.Converters/BitnessFixture.cs @@ -0,0 +1,181 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class BitnessFixture : BaseConverterFixture + { + [Fact] + public void FixComponentBitness() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixRegistrySearchBitness() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixUtilRegistrySearchBitness() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixApprovedExeBitness() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 007e4dfe58293212180a617da25025e52677eee8 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Thu, 11 Feb 2021 14:40:06 -0800 Subject: Preserve unconvertable Win64 attribute content --- src/WixToolset.Converters/WixConverter.cs | 36 +++++++++++++++++----- .../WixToolsetTest.Converters/BitnessFixture.cs | 8 ++++- 2 files changed, 35 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 18cd7115..4d5564b4 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -636,8 +636,8 @@ namespace WixToolset.Converters var win64 = element.Attribute("Win64"); if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var value = win64.Value; - element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); win64.Remove(); } } @@ -755,8 +755,8 @@ namespace WixToolset.Converters var win64 = element.Attribute("Win64"); if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var value = win64.Value; - element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); win64.Remove(); } } @@ -1104,8 +1104,8 @@ namespace WixToolset.Converters var win64 = element.Attribute("Win64"); if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var value = win64.Value; - element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); win64.Remove(); } } @@ -1296,8 +1296,8 @@ namespace WixToolset.Converters var win64 = element.Attribute("Win64"); if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var value = win64.Value; - element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32")); + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); win64.Remove(); } @@ -1341,6 +1341,21 @@ namespace WixToolset.Converters } } + private string UpdateWin64ValueToBitnessValue(XAttribute xWin64Attribute) + { + var value = xWin64Attribute.Value ?? String.Empty; + switch (value) + { + case "yes": + return "always64"; + case "no": + return "always32"; + default: + this.OnError(ConverterTestType.Win64AttributeRenameCannotBeAutomatic, xWin64Attribute, "Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute.", value); + return value; + } + } + private IEnumerable YieldConverterTypes(IEnumerable types) { if (null != types) @@ -1795,6 +1810,11 @@ namespace WixToolset.Converters /// The Win64 attribute has been renamed. Use the Bitness attribute instead. /// Win64AttributeRenamed, + + /// + /// Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute. + /// + Win64AttributeRenameCannotBeAutomatic, } } } diff --git a/src/test/WixToolsetTest.Converters/BitnessFixture.cs b/src/test/WixToolsetTest.Converters/BitnessFixture.cs index 9996806d..e45a9388 100644 --- a/src/test/WixToolsetTest.Converters/BitnessFixture.cs +++ b/src/test/WixToolsetTest.Converters/BitnessFixture.cs @@ -27,6 +27,9 @@ namespace WixToolsetTest.Converters " ", " ", " ", + " ", + " ", + " ", " ", ""); @@ -43,6 +46,9 @@ namespace WixToolsetTest.Converters " ", " ", " ", + " ", + " ", + " ", " ", "" }; @@ -53,7 +59,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(7, errors); + Assert.Equal(10, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); -- cgit v1.2.3-55-g6feb From e0ef9e78ad5478abb650bbb004f7494f47896b0d Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 26 Feb 2021 15:31:39 -0800 Subject: Convert Tag.wixext to SoftwareTag element --- src/WixToolset.Converters/WixConverter.cs | 24 +++++++++++- .../ConverterIntegrationFixture.cs | 8 ++-- .../FirewallExtensionFixture.cs | 2 +- src/test/WixToolsetTest.Converters/TagFixture.cs | 45 ++++++++++++++++++++++ .../Preprocessor/ConvertedPreprocessor.wxs | 4 +- .../TestData/QtExec.bad/v4_expected.wxs | 4 +- .../TestData/QtExec/v4_expected.wxs | 4 +- .../TestData/SingleFile/ConvertedSingleFile.wxs | 4 +- 8 files changed, 80 insertions(+), 15 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/TagFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 4d5564b4..1ba28df3 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -80,6 +80,8 @@ namespace WixToolset.Converters private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; + private static readonly XName SoftwareTagElementName = WixNamespace + "SoftwareTag"; + private static readonly XName TagElementName = XNamespace.None + "Tag"; private static readonly XName TextElementName = WixNamespace + "Text"; private static readonly XName UITextElementName = WixNamespace + "UIText"; private static readonly XName VariableElementName = WixNamespace + "Variable"; @@ -117,7 +119,7 @@ namespace WixToolset.Converters { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, - { "http://schemas.microsoft.com/wix/TagExtension", "http://wixtoolset.org/schemas/v4/wxs/tag" }, + { "http://schemas.microsoft.com/wix/TagExtension", XNamespace.None }, { "http://schemas.microsoft.com/wix/UtilExtension", WixUtilNamespace }, { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, @@ -186,6 +188,7 @@ namespace WixToolset.Converters { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, + { WixConverter.TagElementName, this.ConvertTagElement }, { WixConverter.TextElementName, this.ConvertTextElement }, { WixConverter.UITextElementName, this.ConvertUITextElement }, { WixConverter.VariableElementName, this.ConvertVariableElement }, @@ -1144,6 +1147,14 @@ namespace WixToolset.Converters } } + private void ConvertTagElement(XElement element) + { + if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the element 'SoftwareTag' name.")) + { + element.Name = SoftwareTagElementName; + } + } + private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); @@ -1378,7 +1389,6 @@ namespace WixToolset.Converters { foreach (var element in elements) { - if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) { element.Name = ns.GetName(element.Name.LocalName); @@ -1396,6 +1406,11 @@ namespace WixToolset.Converters { if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) { + if (ns == XNamespace.None) + { + continue; + } + convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); } } @@ -1815,6 +1830,11 @@ namespace WixToolset.Converters /// Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute. /// Win64AttributeRenameCannotBeAutomatic, + + /// + /// The Tag element has been renamed. Use the element 'SoftwareTag' name. + /// + TagElementRenamed, } } } diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index 38afca72..cabc89ee 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -58,7 +58,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); - Assert.Equal(8, errors); + Assert.Equal(9, errors); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -84,7 +84,7 @@ namespace WixToolsetTest.Converters var settingsFile = Path.Combine(folder, "wixcop.settings.xml"); var result = RunConversion(targetFile, settingsFile: settingsFile); - Assert.Equal(8, result.ExitCode); + Assert.Equal(9, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -108,7 +108,7 @@ namespace WixToolsetTest.Converters File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); var result = RunConversion(targetFile); - Assert.Equal(12, result.ExitCode); + Assert.Equal(13, result.ExitCode); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); @@ -133,7 +133,7 @@ namespace WixToolsetTest.Converters var result = RunConversion(targetFile); - Assert.Equal(12, result.ExitCode); + Assert.Equal(13, result.ExitCode); Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); diff --git a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs index f3437078..a101019b 100644 --- a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs +++ b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs @@ -9,7 +9,7 @@ namespace WixToolsetTest.Converters using WixToolsetTest.Converters.Mocks; using Xunit; - public class ExtensionFixture : BaseConverterFixture + public class FirewallExtensionFixture : BaseConverterFixture { [Fact] public void FixRemoteAddressValue() diff --git a/src/test/WixToolsetTest.Converters/TagFixture.cs b/src/test/WixToolsetTest.Converters/TagFixture.cs new file mode 100644 index 00000000..c163ea11 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/TagFixture.cs @@ -0,0 +1,45 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class TagFixture : BaseConverterFixture + { + [Fact] + public void FixTagExtension() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs index b2302b4c..8188d900 100644 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -4,10 +4,10 @@ - + - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs index f26b5d1a..95d2f618 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -4,10 +4,10 @@ - + - + diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs index f5a02e2b..f24d3f8f 100644 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -4,10 +4,10 @@ - + - + diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs index 9a83c237..5bcdaf59 100644 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -4,10 +4,10 @@ - + - + -- cgit v1.2.3-55-g6feb From e9ef9924b00fab9dc3988d10d50d1f11d1ddf097 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 27 Feb 2021 07:25:13 -0800 Subject: Convert Dependency elements to WiX v4 schema --- src/WixToolset.Converters/WixConverter.cs | 136 +++++++++++++++- .../BootstrapperApplicationFixture.cs | 4 +- .../WixToolsetTest.Converters/ConverterFixture.cs | 4 +- .../WixToolsetTest.Converters/DependencyFixture.cs | 178 +++++++++++++++++++++ 4 files changed, 316 insertions(+), 6 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/DependencyFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 1ba28df3..c30a40ac 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -32,6 +32,7 @@ namespace WixToolset.Converters private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; private static readonly XNamespace WixBalNamespace = "http://wixtoolset.org/schemas/v4/wxs/bal"; + private static readonly XNamespace WixDependencyNamespace = "http://wixtoolset.org/schemas/v4/wxs/dependency"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall"; @@ -53,6 +54,9 @@ namespace WixToolset.Converters private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DataElementName = WixNamespace + "Data"; + private static readonly XName OldProvidesElementName = WixDependencyNamespace + "Provides"; + private static readonly XName OldRequiresElementName = WixDependencyNamespace + "Requires"; + private static readonly XName OldRequiresRefElementName = WixDependencyNamespace + "RequiresRef"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; private static readonly XName ErrorElementName = WixNamespace + "Error"; private static readonly XName FeatureElementName = WixNamespace + "Feature"; @@ -72,6 +76,9 @@ namespace WixToolset.Converters private static readonly XName ProductElementName = WixNamespace + "Product"; private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; private static readonly XName PublishElementName = WixNamespace + "Publish"; + private static readonly XName ProvidesElementName = WixNamespace + "Provides"; + private static readonly XName RequiresElementName = WixNamespace + "Requires"; + private static readonly XName RequiresRefElementName = WixNamespace + "RequiresRef"; private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; @@ -106,11 +113,14 @@ namespace WixToolset.Converters private static readonly XName SummaryInformationElementName = WixNamespace + "SummaryInformation"; private static readonly XName MediaTemplateElementName = WixNamespace + "MediaTemplate"; + private static readonly XName DependencyCheckAttributeName = WixDependencyNamespace + "Check"; + private static readonly XName DependencyEnforceAttributeName = WixDependencyNamespace + "Enforce"; + private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() { { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, - { "http://schemas.microsoft.com/wix/DependencyExtension", "http://wixtoolset.org/schemas/v4/wxs/dependency" }, + { "http://schemas.microsoft.com/wix/DependencyExtension", WixDependencyNamespace }, { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, @@ -174,6 +184,9 @@ namespace WixToolset.Converters { WixConverter.MsiPackageElementName, this.ConvertWindowsInstallerPackageElement }, { WixConverter.MspPackageElementName, this.ConvertWindowsInstallerPackageElement }, { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.OldProvidesElementName, this.ConvertProvidesElement }, + { WixConverter.OldRequiresElementName, this.ConvertRequiresElement }, + { WixConverter.OldRequiresRefElementName, this.ConvertRequiresRefElement }, { WixConverter.PayloadElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, { WixConverter.ProductElementName, this.ConvertProductElement }, @@ -275,6 +288,7 @@ namespace WixToolset.Converters // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); + this.RemoveUnusedNamspaces(document.Root); return this.Errors; } @@ -327,6 +341,7 @@ namespace WixToolset.Converters // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); + this.RemoveUnusedNamspaces(document.Root); return this.Errors; } @@ -1136,6 +1151,50 @@ namespace WixToolset.Converters private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertProvidesElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = ProvidesElementName; + } + + if (element.Parent.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Add the 'Check' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyCheckAttributeName, "yes")); + } + } + + private void ConvertRequiresElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = RequiresElementName; + } + + if (element.Parent.Name == ProvidesElementName && + element.Parent.Parent?.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); + } + } + + private void ConvertRequiresRefElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = RequiresRefElementName; + } + + if (element.Parent.Name == ProvidesElementName && + element.Parent.Parent?.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); + } + } + private void ConvertSuppressSignatureValidation(XElement element) { var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); @@ -1149,7 +1208,7 @@ namespace WixToolset.Converters private void ConvertTagElement(XElement element) { - if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the element 'SoftwareTag' name.")) + if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the 'SoftwareTag' element instead.")) { element.Name = SoftwareTagElementName; } @@ -1311,6 +1370,10 @@ namespace WixToolset.Converters element.Add(new XAttribute("Bitness", value)); win64.Remove(); } + //else if (this.OnError(ConverterTestType.BitnessAttributeRequired, element, "Use the Bitness attribute instead.")) + //{ + // element.Add(new XAttribute("Bitness", "always32")); + //} var result = element.Attribute("Result")?.Value; if (result == null || result == "value") @@ -1460,6 +1523,50 @@ namespace WixToolset.Converters whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); } + /// + /// Removes unused namespaces from the element and its children. + /// + /// Root element to start at. + private void RemoveUnusedNamspaces(XElement root) + { + var declarations = new List(); + var namespaces = new HashSet(); + + VisitElement(root, x => + { + if (x is XAttribute a && a.IsNamespaceDeclaration) + { + declarations.Add(a); + namespaces.Add(a.Value); + } + return true; + }); + + foreach (var ns in namespaces.ToList()) + { + VisitElement(root, x => + { + if ((x is XElement e && e.Name.Namespace == ns) || + (x is XAttribute a && !a.IsNamespaceDeclaration && a.Name.Namespace == ns)) + { + namespaces.Remove(ns); + return false; + } + + return true; + }); + } + + foreach (var declaration in declarations) + { + if (namespaces.Contains(declaration.Value) && + this.OnError(ConverterTestType.RemoveUnusedNamespaces, declaration, "The namespace '{0}' is not used. Remove unused namespaces.", declaration.Value)) + { + declaration.Remove(); + } + } + } + /// /// Output an error message to the console. /// @@ -1601,6 +1708,21 @@ namespace WixToolset.Converters } } + private static bool VisitElement(XElement element, Func visitor) + { + if (!visitor(element)) + { + return false; + } + + if (!element.Attributes().All(a => visitor(a))) + { + return false; + } + + return element.Elements().All(e => VisitElement(e, visitor)); + } + private static bool WasImplicitlyStringTyped(string value) { if (value == null) @@ -1835,6 +1957,16 @@ namespace WixToolset.Converters /// The Tag element has been renamed. Use the element 'SoftwareTag' name. /// TagElementRenamed, + + /// + /// The Dependency namespace has been incorporated into WiX v4 namespace. + /// + IntegratedDependencyNamespace, + + /// + /// Remove unused namespaces. + /// + RemoveUnusedNamespaces, } } } diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs index 60386470..158ab3be 100644 --- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs +++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -396,7 +396,7 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", + "", " ", " ", " ", @@ -409,7 +409,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); + Assert.Equal(5, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 20f42068..207d5c8f 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -166,7 +166,7 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", + "", " ", ""); @@ -179,7 +179,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(3, errors); + Assert.Equal(4, errors); Assert.Equal(expected, actual); Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); } diff --git a/src/test/WixToolsetTest.Converters/DependencyFixture.cs b/src/test/WixToolsetTest.Converters/DependencyFixture.cs new file mode 100644 index 00000000..41ded927 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/DependencyFixture.cs @@ -0,0 +1,178 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class DependencyFixture : BaseConverterFixture + { + [Fact] + public void FixPackageDependencyProvides() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPackageDependencyRequires() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPackageDependencyRequiresRef() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixBundleDependencyProvides() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 8d5f37e98167a1e5287778880df167e64df29e11 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Mon, 1 Mar 2021 10:17:41 -0800 Subject: Update WixSuppressModularizationSymbol Partially fixes wixtoolset/issues#5944 --- src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index 92e247e5..b8badf2c 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -619,7 +619,12 @@ namespace WixToolset.Converters.Symbolizer }; } case "WixSuppressModularization": - return DefaultSymbolFromRow(typeof(WixSuppressModularizationSymbol), row, columnZeroIsId: true); + { + return new WixSuppressModularizationSymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + SuppressIdentifier = FieldAsString(row, 0) + }; + } case "WixUI": return DefaultSymbolFromRow(typeof(WixUISymbol), row, columnZeroIsId: true); case "WixVariable": -- cgit v1.2.3-55-g6feb From c8711decea5eeb7121eca485d099c9f3b60fea05 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Mon, 1 Mar 2021 12:29:20 -0800 Subject: Update to latest build infrastructure --- .gitignore | 43 ++++++++++++++++++++++++++++++++----------- appveyor.cmd | 16 ++++++++++++---- appveyor.yml | 6 ++---- src/CSharp.Build.props | 13 ------------- src/Directory.Build.props | 4 +--- src/Directory.Build.targets | 9 ++------- src/Directory.csproj.props | 13 +++++++++++++ src/Directory.csproj.targets | 26 ++++++++++++++++++++++++++ 8 files changed, 88 insertions(+), 42 deletions(-) delete mode 100644 src/CSharp.Build.props create mode 100644 src/Directory.csproj.props create mode 100644 src/Directory.csproj.targets (limited to 'src') diff --git a/.gitignore b/.gitignore index 3e8a1553..1ee53850 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,9 @@ # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs +# Mono auto generated files +mono_crash.* + # Build results [Dd]ebug/ [Dd]ebugPublic/ @@ -20,12 +23,14 @@ [Rr]eleases/ x64/ x86/ +[Ww][Ii][Nn]32/ [Aa][Rr][Mm]/ [Aa][Rr][Mm]64/ bld/ [Bb]in/ [Oo]bj/ [Ll]og/ +[Ll]ogs/ # Visual Studio 2015/2017 cache/options directory .vs/ @@ -39,9 +44,10 @@ Generated\ Files/ [Tt]est[Rr]esult*/ [Bb]uild[Ll]og.* -# NUNIT +# NUnit *.VisualState.xml TestResult.xml +nunit-*.xml # Build Results of an ATL Project [Dd]ebugPS/ @@ -56,6 +62,9 @@ project.lock.json project.fragment.lock.json artifacts/ +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + # StyleCop StyleCopReport.xml @@ -122,9 +131,6 @@ _ReSharper*/ *.[Rr]e[Ss]harper *.DotSettings.user -# JustCode is a .NET coding add-in -.JustCode - # TeamCity is a build add-in _TeamCity* @@ -135,6 +141,11 @@ _TeamCity* .axoCover/* !.axoCover/settings.json +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + # Visual Studio code coverage results *.coverage *.coveragexml @@ -182,6 +193,8 @@ PublishScripts/ # NuGet Packages *.nupkg +# NuGet Symbol Packages +*.snupkg # The packages folder can be ignored because of Package Restore **/[Pp]ackages/* # except build/, which is used as an MSBuild target. @@ -206,6 +219,8 @@ BundleArtifacts/ Package.StoreAssociation.xml _pkginfo.txt *.appx +*.appxbundle +*.appxupload # Visual Studio cache files # files ending in .cache can be ignored @@ -231,8 +246,6 @@ orleans.codegen.cs # Since there are multiple workflows, uncomment next line to ignore bower_components # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) #bower_components/ -# ASP.NET Core default setup: bower directory is configured as wwwroot/lib/ and bower restore is true -**/wwwroot/lib/ # RIA/Silverlight projects Generated_Code/ @@ -257,6 +270,9 @@ ServiceFabricBackup/ *.bim.layout *.bim_*.settings *.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl # Microsoft Fakes FakesAssemblies/ @@ -292,10 +308,6 @@ paket-files/ # FAKE - F# Make .fake/ -# JetBrains Rider -.idea/ -*.sln.iml - # CodeRush personal settings .cr/personal @@ -337,5 +349,14 @@ ASALocalRun/ # Local History for Visual Studio .localhistory/ -# BeatPulse healthcheck temp database +# BeatPulse healthcheck temp database healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd diff --git a/appveyor.cmd b/appveyor.cmd index 27d5eaec..02db695b 100644 --- a/appveyor.cmd +++ b/appveyor.cmd @@ -1,12 +1,20 @@ @setlocal @pushd %~dp0 @set _P=%~dp0build\Release\publish +@set _C=Release +@if /i "%1"=="debug" set _C=Debug -dotnet test -c Release src\test\WixToolsetTest.Converters || exit /b -dotnet test -c Release src\test\WixToolsetTest.Converters.Symbolizer || exit /b +:: Restore +msbuild -p:Configuration=%_C% -t:Restore || exit /b -dotnet pack -c Release src\WixToolset.Converters || exit /b -dotnet pack -c Release src\WixToolset.Converters.Symbolizer || exit /b +:: Build +msbuild -p:Configuration=%_C% || exit /b + +:: Test +dotnet test -c %_C% --no-build || exit /b + +:: Pack +msbuild -p:Configuration=%_C% -p:NoBuild=true -t:Pack || exit /b @popd @endlocal diff --git a/appveyor.yml b/appveyor.yml index f602d07c..c53cc9cc 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -21,8 +21,6 @@ environment: build_script: - appveyor.cmd -test: off - pull_requests: do_not_increment_build_number: true @@ -35,8 +33,8 @@ skip_tags: true artifacts: - path: build\Release\**\*.nupkg name: nuget -- path: build\Release\**\*.msi - name: msi +- path: build\Release\**\*.snupkg + name: snupkg notifications: - provider: Slack diff --git a/src/CSharp.Build.props b/src/CSharp.Build.props deleted file mode 100644 index 81d24ad1..00000000 --- a/src/CSharp.Build.props +++ /dev/null @@ -1,13 +0,0 @@ - - - - - true - true - $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk)) - false - - diff --git a/src/Directory.Build.props b/src/Directory.Build.props index f83cc154..b3c6287c 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -22,8 +22,6 @@ WiX Toolset - - - + diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index cb988931..2fcc765a 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -9,11 +9,6 @@ See the original here: https://github.com/dotnet/sdk/issues/1151#issuecomment-385133284 --> - - false - $(OutputPath)\$(AssemblyName).xml - - true $(SolutionPath) @@ -45,12 +40,12 @@ - + - + diff --git a/src/Directory.csproj.props b/src/Directory.csproj.props new file mode 100644 index 00000000..81d24ad1 --- /dev/null +++ b/src/Directory.csproj.props @@ -0,0 +1,13 @@ + + + + + true + true + $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk)) + false + + diff --git a/src/Directory.csproj.targets b/src/Directory.csproj.targets new file mode 100644 index 00000000..c3270426 --- /dev/null +++ b/src/Directory.csproj.targets @@ -0,0 +1,26 @@ + + + + + false + $(OutputPath)\$(AssemblyName).xml + + + + + $(PrivateRepositoryUrl.Replace('.git','')) + + $(MSBuildProjectName).nuspec + $(OutputPath)..\ + $(NuspecProperties);Id=$(PackageId);Authors=$(Authors);Copyright=$(Copyright);Description=$(Description);Title=$(Title) + $(NuspecProperties);Version=$(PackageVersion);RepositoryCommit=$(SourceRevisionId);RepositoryType=$(RepositoryType);RepositoryUrl=$(PrivateRepositoryUrl);ProjectFolder=$(MSBuildProjectDirectory)\;ProjectUrl=$(ProjectUrl) + true + snupkg + + + + -- cgit v1.2.3-55-g6feb From 7d43a882fe2554c6f424c687ca2c564a83e64c81 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 2 Mar 2021 02:49:28 -0800 Subject: Fix Win64 to Bitness, even in v4 .wxs code Also updated AccessModifiers and decide not to change v3 Bundle .wxs code. --- .../ConvertSymbols.cs | 38 +++++++++--------- src/WixToolset.Converters/WixConverter.cs | 46 +++++++++------------- 2 files changed, 37 insertions(+), 47 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index b8badf2c..c2bc8d29 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -129,7 +129,7 @@ namespace WixToolset.Converters.Symbolizer keyPathType = ComponentKeyPathType.OdbcDataSource; } - return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { ComponentId = FieldAsString(row, 1), DirectoryRef = FieldAsString(row, 2), @@ -159,7 +159,7 @@ namespace WixToolset.Converters.Symbolizer var sourceType = DetermineCustomActionSourceType(caType); var targetType = DetermineCustomActionTargetType(caType); - return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { ExecutionType = executionType, SourceType = sourceType, @@ -180,7 +180,7 @@ namespace WixToolset.Converters.Symbolizer var id = FieldAsString(row, 0); var splits = SplitDefaultDir(FieldAsString(row, 2)); - var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, id)) { ParentDirectoryRef = FieldAsString(row, 1), Name = splits[0], @@ -202,7 +202,7 @@ namespace WixToolset.Converters.Symbolizer { var splitName = FieldAsString(row, 3)?.Split('|'); - var symbol = new DuplicateFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + var symbol = new DuplicateFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { ComponentRef = FieldAsString(row, 1), FileRef = FieldAsString(row, 2), @@ -230,7 +230,7 @@ namespace WixToolset.Converters.Symbolizer installDefault = FeatureInstallDefault.Source; } - return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { ParentFeatureRef = FieldAsString(row, 1), Title = FieldAsString(row, 2), @@ -263,7 +263,7 @@ namespace WixToolset.Converters.Symbolizer var id = FieldAsString(row, 0); var splitName = FieldAsString(row, 2).Split('|'); - var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, id)) + var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, id)) { ComponentRef = FieldAsString(row, 1), Name = splitName.Length > 1 ? splitName[1] : splitName[0], @@ -309,7 +309,7 @@ namespace WixToolset.Converters.Symbolizer var splitName = FieldAsString(row, 1).Split('|'); var action = FieldAsInt(row, 6); - var symbol = new IniFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + var symbol = new IniFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { FileName = splitName.Length > 1 ? splitName[1] : splitName[0], ShortFileName = splitName.Length > 1 ? splitName[0] : null, @@ -327,7 +327,7 @@ namespace WixToolset.Converters.Symbolizer { var splitName = FieldAsString(row, 1).Split('|'); - var symbol = new IniLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + var symbol = new IniLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { FileName = splitName.Length > 1 ? splitName[1] : splitName[0], ShortFileName = splitName.Length > 1 ? splitName[0] : null, @@ -344,7 +344,7 @@ namespace WixToolset.Converters.Symbolizer case "Media": { var diskId = FieldAsInt(row, 0); - var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, diskId)) + var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, diskId)) { DiskId = diskId, LastSequence = FieldAsNullableInt(row, 1), @@ -375,7 +375,7 @@ namespace WixToolset.Converters.Symbolizer var componentId = FieldAsString(row, 0); if (componentsById.TryGetValue(componentId, out var componentRow)) { - return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(componentRow, 5))) + return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(componentRow, 5))) { ComponentRef = componentId, FeatureRef = FieldAsString(row, 1), @@ -446,7 +446,7 @@ namespace WixToolset.Converters.Symbolizer } } - return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { Root = (RegistryRootType)FieldAsInt(row, 1), Key = FieldAsString(row, 2), @@ -461,7 +461,7 @@ namespace WixToolset.Converters.Symbolizer { var type = FieldAsInt(row, 4); - return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { Root = (RegistryRootType)FieldAsInt(row, 1), Key = FieldAsString(row, 2), @@ -475,7 +475,7 @@ namespace WixToolset.Converters.Symbolizer var splitName = FieldAsString(row, 2).Split('|'); var installMode = FieldAsInt(row, 4); - return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { ComponentRef = FieldAsString(row, 1), FileName = splitName.Length > 1 ? splitName[1] : splitName[0], @@ -487,7 +487,7 @@ namespace WixToolset.Converters.Symbolizer } case "RemoveRegistry": { - return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { Action = RemoveRegistryActionType.RemoveOnInstall, Root = (RegistryRootType)FieldAsInt(row, 1), @@ -505,7 +505,7 @@ namespace WixToolset.Converters.Symbolizer { var events = FieldAsInt(row, 2); var wait = FieldAsNullableInt(row, 4); - return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { Name = FieldAsString(row, 1), Arguments = FieldAsString(row, 3), @@ -526,7 +526,7 @@ namespace WixToolset.Converters.Symbolizer { var splitName = FieldAsString(row, 2).Split('|'); - return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { DirectoryRef = FieldAsString(row, 1), Name = splitName.Length > 1 ? splitName[1] : splitName[0], @@ -553,7 +553,7 @@ namespace WixToolset.Converters.Symbolizer case "Upgrade": { var attributes = FieldAsInt(row, 4); - return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Public, FieldAsString(row, 0))) + return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) { UpgradeCode = FieldAsString(row, 0), VersionMin = FieldAsString(row, 1), @@ -797,9 +797,9 @@ namespace WixToolset.Converters.Symbolizer case Wix3.ColumnType.Localized: case Wix3.ColumnType.Object: case Wix3.ColumnType.Preserved: - return new Identifier(AccessModifier.Public, (string)row.Fields[0].Data); + return new Identifier(AccessModifier.Global, (string)row.Fields[0].Data); case Wix3.ColumnType.Number: - return new Identifier(AccessModifier.Public, FieldAsInt(row, 0)); + return new Identifier(AccessModifier.Global, FieldAsInt(row, 0)); default: return null; } diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c30a40ac..83a333f0 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -649,15 +649,12 @@ namespace WixToolset.Converters private void ConvertApprovedExeForElevationElement(XElement element) { - if (this.SourceVersion < 4) + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); + win64.Remove(); } } @@ -1117,15 +1114,12 @@ namespace WixToolset.Converters private void ConvertRegistrySearchElement(XElement element) { - if (this.SourceVersion < 4) + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); + win64.Remove(); } } @@ -1361,20 +1355,16 @@ namespace WixToolset.Converters private void ConvertUtilRegistrySearchElement(XElement element) { - if (this.SourceVersion < 4) + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } - //else if (this.OnError(ConverterTestType.BitnessAttributeRequired, element, "Use the Bitness attribute instead.")) - //{ - // element.Add(new XAttribute("Bitness", "always32")); - //} + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); + win64.Remove(); + } + if (this.SourceVersion < 4) + { var result = element.Attribute("Result")?.Value; if (result == null || result == "value") { -- cgit v1.2.3-55-g6feb From 8929554278be056a73160ec5f06ab6cc6b8c4fb4 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Mon, 1 Mar 2021 18:11:41 -0600 Subject: Add conversion for renaming RemotePayload, and warn about changed hash. #3992, #4183 --- src/WixToolset.Converters/WixConverter.cs | 65 +++++++++++++ .../WixToolsetTest.Converters/ConverterFixture.cs | 33 ------- .../RemotePayloadFixture.cs | 104 +++++++++++++++++++++ 3 files changed, 169 insertions(+), 33 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 83a333f0..83053725 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -66,10 +66,12 @@ namespace WixToolset.Converters private static readonly XName LaunchElementName = WixNamespace + "Launch"; private static readonly XName LevelElementName = WixNamespace + "Level"; private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; + private static readonly XName ExePackagePayloadElementName = WixNamespace + "ExePackagePayload"; private static readonly XName ModuleElementName = WixNamespace + "Module"; private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; + private static readonly XName MsuPackagePayloadElementName = WixNamespace + "MsuPackagePayload"; private static readonly XName PackageElementName = WixNamespace + "Package"; private static readonly XName PayloadElementName = WixNamespace + "Payload"; private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; @@ -1099,6 +1101,44 @@ namespace WixToolset.Converters private void ConvertRemotePayloadElement(XElement element) { + var xParent = element.Parent; + + if (xParent.Name == ExePackageElementName && + this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'ExePackagePayload' instead.")) + { + element.Name = ExePackagePayloadElementName; + } + else if (xParent.Name == MsuPackageElementName && + this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'MsuPackagePayload' instead.")) + { + element.Name = MsuPackagePayloadElementName; + } + + var xName = xParent.Attribute("Name"); + if (xName != null && + this.OnError(ConverterTestType.NameAttributeMovedToRemotePayload, xParent, "The Name attribute must be specified on the child XxxPackagePayload element when using a remote payload.")) + { + element.SetAttributeValue("Name", xName.Value); + xName.Remove(); + } + + var xDownloadUrl = xParent.Attribute("DownloadUrl"); + if (xDownloadUrl != null && + this.OnError(ConverterTestType.DownloadUrlAttributeMovedToRemotePayload, xParent, "The DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload.")) + { + element.SetAttributeValue("DownloadUrl", xDownloadUrl.Value); + xDownloadUrl.Remove(); + } + + var xCompressed = xParent.Attribute("Compressed"); + if (xCompressed != null && + this.OnError(ConverterTestType.CompressedAttributeUnnecessaryForRemotePayload, xParent, "The Compressed attribute should not be specified when using a remote payload.")) + { + xCompressed.Remove(); + } + + this.OnError(ConverterTestType.BurnHashAlgorithmChanged, element, "The hash algorithm for bundles changed from SHA1 to SHA512."); + RemoveIfPresent(element.Attribute("CertificatePublicKey")); RemoveIfPresent(element.Attribute("CertificateThumbprint")); @@ -1957,6 +1997,31 @@ namespace WixToolset.Converters /// Remove unused namespaces. /// RemoveUnusedNamespaces, + + /// + /// The Remote element has been renamed. Use the "XxxPackagePayload" element instead. + /// + RemotePayloadRenamed, + + /// + /// The XxxPackage/@Name attribute must be specified on the child XxxPackagePayload element when using a remote payload. + /// + NameAttributeMovedToRemotePayload, + + /// + /// The XxxPackage/@Compressed attribute should not be specified when using a remote payload. + /// + CompressedAttributeUnnecessaryForRemotePayload, + + /// + /// The XxxPackage/@DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload. + /// + DownloadUrlAttributeMovedToRemotePayload, + + /// + /// The hash algorithm used for bundles changed from SHA1 to SHA512. + /// + BurnHashAlgorithmChanged, } } } diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 207d5c8f..4d815247 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -330,39 +330,6 @@ namespace WixToolsetTest.Converters Assert.Equal(expected, actual); } - [Fact] - public void CanConvertRemotePayloadElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - [Fact] public void CanConvertSuppressSignatureValidationNo() { diff --git a/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs b/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs new file mode 100644 index 00000000..b2640e13 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs @@ -0,0 +1,104 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class RemotePayloadFixture : BaseConverterFixture + { + [Fact] + public void CanConvertExePackageRemotePayload() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CanConvertMsuPackageRemotePayload() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 117a583760e72247f35d686cdd90866cb98bb17c Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Mon, 1 Mar 2021 18:17:37 -0600 Subject: Fix spelling of RemoveUnusedNamespaces. --- src/WixToolset.Converters/WixConverter.cs | 6 +++--- .../WixToolsetTest.Converters.Symbolizer.csproj | 2 +- src/test/WixToolsetTest.Converters/ConverterFixture.cs | 2 +- .../WixToolsetTest.Converters.csproj | 14 +------------- 4 files changed, 6 insertions(+), 18 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 83053725..3348e49c 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -290,7 +290,7 @@ namespace WixToolset.Converters // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); - this.RemoveUnusedNamspaces(document.Root); + this.RemoveUnusedNamespaces(document.Root); return this.Errors; } @@ -343,7 +343,7 @@ namespace WixToolset.Converters // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); - this.RemoveUnusedNamspaces(document.Root); + this.RemoveUnusedNamespaces(document.Root); return this.Errors; } @@ -1557,7 +1557,7 @@ namespace WixToolset.Converters /// Removes unused namespaces from the element and its children. /// /// Root element to start at. - private void RemoveUnusedNamspaces(XElement root) + private void RemoveUnusedNamespaces(XElement root) { var declarations = new List(); var namespaces = new HashSet(); diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj index 57ff1968..995d9297 100644 --- a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj +++ b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj @@ -9,7 +9,7 @@ - + diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 4d815247..39521da0 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -157,7 +157,7 @@ namespace WixToolsetTest.Converters } [Fact] - public void CanConvertExtensionNamespace() + public void CanRemoveUnusedNamespaces() { var parse = String.Join(Environment.NewLine, "", diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 902494a2..8b525497 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -8,19 +8,7 @@ - - - - - - - - - - - - - + -- cgit v1.2.3-55-g6feb From d1050931018d6e8dd06189202492df666dfbb594 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Fri, 12 Mar 2021 17:11:44 -0600 Subject: Add conversion for BootstrapperApplicationData to BundleCustomData. #6176 --- src/WixToolset.Converters/FixupCommandBase.cs | 18 +++ src/WixToolset.Converters/WixConverter.cs | 160 ++++++++++++++++-- .../CustomTableFixture.cs | 178 ++++++++++++++++++++- 3 files changed, 337 insertions(+), 19 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/FixupCommandBase.cs b/src/WixToolset.Converters/FixupCommandBase.cs index 7ecce543..21282d07 100644 --- a/src/WixToolset.Converters/FixupCommandBase.cs +++ b/src/WixToolset.Converters/FixupCommandBase.cs @@ -29,6 +29,8 @@ namespace WixToolset.Converters protected bool ShowHelp { get; set; } + protected CustomTableTarget CustomTableSetting { get; set; } + protected bool DryRun { get; set; } protected HashSet ErrorsAsWarnings { get; } @@ -68,6 +70,22 @@ namespace WixToolset.Converters this.StopParsing = true; return true; + case "-custom-table": + var customTableSetting = parser.GetNextArgumentOrError(argument); + switch (customTableSetting) + { + case "bundle": + this.CustomTableSetting = CustomTableTarget.Bundle; + break; + case "msi": + this.CustomTableSetting = CustomTableTarget.Msi; + break; + default: + parser.ReportErrorArgument(argument); + break; + } + return true; + case "n": case "-dry-run": this.DryRun = true; diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 3348e49c..9ada4745 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -14,6 +14,27 @@ namespace WixToolset.Converters using WixToolset.Data; using WixToolset.Extensibility.Services; + /// + /// How to convert CustomTable elements. + /// + public enum CustomTableTarget + { + /// + /// Ambiguous elements will be left alone. + /// + Unknown, + + /// + /// Use CustomTable, CustomTableRef, and Unreal. + /// + Msi, + + /// + /// Use BundleCustomData and BundleCustomDataRef. + /// + Bundle, + } + /// /// WiX source code converter. /// @@ -45,19 +66,25 @@ namespace WixToolset.Converters private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef"; private static readonly XName ApprovedExeForElevationElementName = WixNamespace + "ApprovedExeForElevation"; - private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; + private static readonly XName BundleAttributeElementName = WixNamespace + "BundleAttribute"; + private static readonly XName BundleAttributeDefinitionElementName = WixNamespace + "BundleAttributeDefinition"; + private static readonly XName BundleCustomDataElementName = WixNamespace + "BundleCustomData"; + private static readonly XName BundleCustomDataRefElementName = WixNamespace + "BundleCustomDataRef"; + private static readonly XName BundleElementElementName = WixNamespace + "BundleElement"; + private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; + private static readonly XName CustomTableRefElementName = WixNamespace + "CustomTableRef"; private static readonly XName CatalogElementName = WixNamespace + "Catalog"; private static readonly XName ColumnElementName = WixNamespace + "Column"; private static readonly XName ComponentElementName = WixNamespace + "Component"; private static readonly XName ControlElementName = WixNamespace + "Control"; private static readonly XName ConditionElementName = WixNamespace + "Condition"; private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; - private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DataElementName = WixNamespace + "Data"; private static readonly XName OldProvidesElementName = WixDependencyNamespace + "Provides"; private static readonly XName OldRequiresElementName = WixDependencyNamespace + "Requires"; private static readonly XName OldRequiresRefElementName = WixDependencyNamespace + "RequiresRef"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; + private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; private static readonly XName ErrorElementName = WixNamespace + "Error"; private static readonly XName FeatureElementName = WixNamespace + "Feature"; private static readonly XName FileElementName = WixNamespace + "File"; @@ -85,6 +112,7 @@ namespace WixToolset.Converters private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; + private static readonly XName RowElementName = WixNamespace + "Row"; private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; @@ -156,7 +184,8 @@ namespace WixToolset.Converters /// Indentation value to use when validating leading whitespace. /// Test errors to display as warnings. /// Test errors to ignore. - public WixConverter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null) + /// How to convert CustomTable elements. + public WixConverter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null, CustomTableTarget customTableTarget = CustomTableTarget.Unknown) { this.ConvertElementMapping = new Dictionary> { @@ -170,9 +199,10 @@ namespace WixToolset.Converters { WixConverter.ApprovedExeForElevationElementName, this.ConvertApprovedExeForElevationElement }, { WixConverter.CatalogElementName, this.ConvertCatalogElement }, { WixConverter.ColumnElementName, this.ConvertColumnElement }, - { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, - { WixConverter.ControlElementName, this.ConvertControlElement }, { WixConverter.ComponentElementName, this.ConvertComponentElement }, + { WixConverter.ControlElementName, this.ConvertControlElement }, + { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, + { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, { WixConverter.DataElementName, this.ConvertDataElement }, { WixConverter.DirectoryElementName, this.ConvertDirectoryElement }, { WixConverter.FeatureElementName, this.ConvertFeatureElement }, @@ -198,7 +228,6 @@ namespace WixToolset.Converters { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement }, { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, - { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, @@ -224,8 +253,12 @@ namespace WixToolset.Converters this.ErrorsAsWarnings = new HashSet(this.YieldConverterTypes(errorsAsWarnings)); this.IgnoreErrors = new HashSet(this.YieldConverterTypes(ignoreErrors)); + + this.CustomTableSetting = customTableTarget; } + private CustomTableTarget CustomTableSetting { get; } + private int Errors { get; set; } private HashSet ErrorsAsWarnings { get; set; } @@ -717,11 +750,104 @@ namespace WixToolset.Converters private void ConvertCustomTableElement(XElement element) { var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); - if (bootstrapperApplicationData != null - && this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) + if (bootstrapperApplicationData?.Value == "no") + { + if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) + { + bootstrapperApplicationData.Remove(); + } + } + else + { + if (element.Elements(ColumnElementName).Any() || bootstrapperApplicationData != null) + { + // Table definition + if (bootstrapperApplicationData != null) + { + switch (this.CustomTableSetting) + { + case CustomTableTarget.Bundle: + if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'BundleCustomData' element for Bundles.", bootstrapperApplicationData.Name)) + { + element.Name = WixConverter.BundleCustomDataElementName; + bootstrapperApplicationData.Remove(); + this.ConvertCustomTableElementToBundle(element); + } + break; + case CustomTableTarget.Msi: + if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) + { + element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); + bootstrapperApplicationData.Remove(); + } + break; + default: + this.OnError(ConverterTestType.CustomTableNotAlwaysConvertable, element, "The CustomTable element contains deprecated '{0}' attribute so can't be converted. Use the 'Unreal' attribute for MSI. Use the 'BundleCustomData' element for Bundles. Use the --custom-table argument to force conversion to 'msi' or 'bundle'", bootstrapperApplicationData.Name); + break; + } + } + } + else + { + // Table ref + switch (this.CustomTableSetting) + { + case CustomTableTarget.Bundle: + if (this.OnError(ConverterTestType.CustomTableRef, element, "CustomTable elements that don't contain the table definition are now BundleCustomDataRef for Bundles.")) + { + element.Name = WixConverter.BundleCustomDataRefElementName; + this.ConvertCustomTableElementToBundle(element); + } + break; + case CustomTableTarget.Msi: + if (this.OnError(ConverterTestType.CustomTableRef, element, "CustomTable elements that don't contain the table definition are now CustomTableRef for MSI.")) + { + element.Name = WixConverter.CustomTableRefElementName; + } + break; + default: + this.OnError(ConverterTestType.CustomTableNotAlwaysConvertable, element, "The CustomTable element contains no 'Column' elements so can't be converted. Use the 'CustomTableRef' element for MSI. Use the 'BundleCustomDataRef' element for Bundles. Use the --custom-table argument to force conversion to 'msi' or 'bundle'"); + break; + } + } + } + } + + private void ConvertCustomTableElementToBundle(XElement element) + { + foreach (var xColumn in element.Elements(ColumnElementName)) { - element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); - bootstrapperApplicationData.Remove(); + xColumn.Name = WixConverter.BundleAttributeDefinitionElementName; + + foreach (var xAttribute in xColumn.Attributes().ToList()) + { + if (xAttribute.Name.LocalName != "Id" && + (xAttribute.Name.Namespace == WixConverter.Wix3Namespace || + xAttribute.Name.Namespace == WixConverter.WixNamespace || + String.IsNullOrEmpty(xAttribute.Name.Namespace.NamespaceName))) + { + xAttribute.Remove(); + } + } + } + + foreach (var xRow in element.Elements(RowElementName)) + { + xRow.Name = WixConverter.BundleElementElementName; + + foreach (var xData in xRow.Elements(DataElementName)) + { + xData.Name = WixConverter.BundleAttributeElementName; + + var xColumn = xData.Attribute("Column"); + if (xColumn != null) + { + xData.Add(new XAttribute("Id", xColumn.Value)); + xColumn.Remove(); + } + + this.ConvertInnerTextToAttribute(xData, "Value"); + } } } @@ -1165,8 +1291,6 @@ namespace WixToolset.Converters private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); - private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - private void ConvertDataElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); private void ConvertSequenceElement(XElement element) @@ -1854,7 +1978,7 @@ namespace WixToolset.Converters AssignDirectoryNameFromShortName, /// - /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal. + /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal for MSI. Use BundleCustomData element for Bundles. /// BootstrapperApplicationDataDeprecated, @@ -2022,6 +2146,16 @@ namespace WixToolset.Converters /// The hash algorithm used for bundles changed from SHA1 to SHA512. /// BurnHashAlgorithmChanged, + + /// + /// CustomTable elements can't always be converted. + /// + CustomTableNotAlwaysConvertable, + + /// + /// CustomTable elements that don't contain the table definition are now CustomTableRef. + /// + CustomTableRef, } } } diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs index c51d1923..2b81a863 100644 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -83,7 +83,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); + Assert.Equal(4, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); @@ -126,7 +126,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(2, errors); + Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); @@ -162,14 +162,154 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(2, errors); + Assert.Equal(3, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); } [Fact] - public void CanConvertCustomTableBootstrapperApplicationData() + public void CanConvertBundleCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Bundle); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertBundleCustomTableRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Bundle); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertMsiCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Msi); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertMsiCustomTableRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Msi); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanDetectAmbiguousCustomTableBootstrapperApplicationData() { var parse = String.Join(Environment.NewLine, "", @@ -178,13 +318,39 @@ namespace WixToolsetTest.Converters var expected = String.Join(Environment.NewLine, "", - " ", + " ", ""); var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); + var converter = new WixConverter(messaging, 2); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanRemoveBootstrapperApplicationDataFromRealCustomTable() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2); var errors = converter.ConvertDocument(document); -- cgit v1.2.3-55-g6feb From 6ffe147d054e6515b5276f6412994fe88392366b Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Mon, 15 Mar 2021 20:46:45 -0400 Subject: Update service provider dependency --- src/WixToolset.Converters/ConvertCommand.cs | 2 +- src/WixToolset.Converters/ConverterExtensionCommandLine.cs | 4 ++-- src/WixToolset.Converters/ConverterExtensionFactory.cs | 4 ++-- src/WixToolset.Converters/FormatCommand.cs | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs index e29b176e..b6826f43 100644 --- a/src/WixToolset.Converters/ConvertCommand.cs +++ b/src/WixToolset.Converters/ConvertCommand.cs @@ -11,7 +11,7 @@ namespace WixToolset.Converters { private const string SettingsFileDefault = "wix.convert.settings.xml"; - public ConvertCommand(IWixToolsetServiceProvider serviceProvider) + public ConvertCommand(IServiceProvider serviceProvider) { this.Messaging = serviceProvider.GetService(); } diff --git a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs index d78b89cc..8d740a3a 100644 --- a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs +++ b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs @@ -14,12 +14,12 @@ namespace WixToolset.Converters /// internal class ConverterExtensionCommandLine : BaseExtensionCommandLine { - public ConverterExtensionCommandLine(IWixToolsetServiceProvider serviceProvider) + public ConverterExtensionCommandLine(IServiceProvider serviceProvider) { this.ServiceProvider = serviceProvider; } - private IWixToolsetServiceProvider ServiceProvider { get; } + private IServiceProvider ServiceProvider { get; } public override IEnumerable CommandLineSwitches => new ExtensionCommandLineSwitch[] { diff --git a/src/WixToolset.Converters/ConverterExtensionFactory.cs b/src/WixToolset.Converters/ConverterExtensionFactory.cs index 51099e67..d4f480aa 100644 --- a/src/WixToolset.Converters/ConverterExtensionFactory.cs +++ b/src/WixToolset.Converters/ConverterExtensionFactory.cs @@ -8,12 +8,12 @@ namespace WixToolset.Converters internal class ConverterExtensionFactory : IExtensionFactory { - public ConverterExtensionFactory(IWixToolsetServiceProvider serviceProvider) + public ConverterExtensionFactory(IServiceProvider serviceProvider) { this.ServiceProvider = serviceProvider; } - private IWixToolsetServiceProvider ServiceProvider { get; } + private IServiceProvider ServiceProvider { get; } public bool TryCreateExtension(Type extensionType, out object extension) { diff --git a/src/WixToolset.Converters/FormatCommand.cs b/src/WixToolset.Converters/FormatCommand.cs index e9965df3..0861fc51 100644 --- a/src/WixToolset.Converters/FormatCommand.cs +++ b/src/WixToolset.Converters/FormatCommand.cs @@ -11,7 +11,7 @@ namespace WixToolset.Converters { private const string SettingsFileDefault = "wix.format.settings.xml"; - public FormatCommand(IWixToolsetServiceProvider serviceProvider) + public FormatCommand(IServiceProvider serviceProvider) { this.Messaging = serviceProvider.GetService(); } -- cgit v1.2.3-55-g6feb From 7e44ed28026cad6f624a836a5faf9d9b6174d6f3 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Sun, 21 Mar 2021 22:03:32 -0400 Subject: Convert obsolete RegistryKey/@Action. --- src/WixToolset.Converters/WixConverter.cs | 29 ++++++++++++ .../WixToolsetTest.Converters/RegistryFixture.cs | 54 ++++++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/RegistryFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 9ada4745..09a4168a 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -110,6 +110,7 @@ namespace WixToolset.Converters private static readonly XName RequiresRefElementName = WixNamespace + "RequiresRef"; private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; + private static readonly XName RegistryKeyElementName = WixNamespace + "RegistryKey"; private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; private static readonly XName RowElementName = WixNamespace + "Row"; @@ -225,6 +226,7 @@ namespace WixToolset.Converters { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, { WixConverter.PublishElementName, this.ConvertPublishElement }, { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, + { WixConverter.RegistryKeyElementName, this.ConvertRegistryKeyElement }, { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement }, { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, @@ -1225,6 +1227,28 @@ namespace WixToolset.Converters private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertRegistryKeyElement(XElement element) + { + var xAction = element.Attribute("Action"); + + if (xAction != null + && this.OnError(ConverterTestType.RegistryKeyActionObsolete, element, "The RegistryKey element's Action attribute is obsolete. Action='create' will be converted to ForceCreateOnInstall='yes'. Action='createAndRemoveOnUninstall' will be converted to ForceCreateOnInstall='yes' and ForceDeleteOnUninstall='yes'.")) + { + switch (xAction?.Value) + { + case "create": + element.SetAttributeValue("ForceCreateOnInstall", "yes"); + break; + case "createAndRemoveOnUninstall": + element.SetAttributeValue("ForceCreateOnInstall", "yes"); + element.SetAttributeValue("ForceDeleteOnUninstall", "yes"); + break; + } + + xAction.Remove(); + } + } + private void ConvertRemotePayloadElement(XElement element) { var xParent = element.Parent; @@ -2156,6 +2180,11 @@ namespace WixToolset.Converters /// CustomTable elements that don't contain the table definition are now CustomTableRef. /// CustomTableRef, + + /// + /// The RegistryKey element's Action attribute is obsolete. + /// + RegistryKeyActionObsolete, } } } diff --git a/src/test/WixToolsetTest.Converters/RegistryFixture.cs b/src/test/WixToolsetTest.Converters/RegistryFixture.cs new file mode 100644 index 00000000..405f5416 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/RegistryFixture.cs @@ -0,0 +1,54 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class RegistryFixture : BaseConverterFixture + { + [Fact] + public void FixRegistryKeyAction() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 7dff57257c06da8c861a1a54e32f97fd9f22357c Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 23 Mar 2021 16:26:20 -0700 Subject: Fixup SoftwareTag deprecations and SoftwareTagRef conversion Fixes wixtoolset/issues#6379 --- src/WixToolset.Converters/WixConverter.cs | 95 ++++++++++++++---------- src/test/WixToolsetTest.Converters/TagFixture.cs | 66 ++++++++++++++++ 2 files changed, 122 insertions(+), 39 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 09a4168a..b8f2a516 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -119,7 +119,9 @@ namespace WixToolset.Converters private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; private static readonly XName SoftwareTagElementName = WixNamespace + "SoftwareTag"; + private static readonly XName SoftwareTagRefElementName = WixNamespace + "SoftwareTagRef"; private static readonly XName TagElementName = XNamespace.None + "Tag"; + private static readonly XName TagRefElementName = XNamespace.None + "TagRef"; private static readonly XName TextElementName = WixNamespace + "Text"; private static readonly XName UITextElementName = WixNamespace + "UIText"; private static readonly XName VariableElementName = WixNamespace + "Variable"; @@ -235,6 +237,7 @@ namespace WixToolset.Converters { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, { WixConverter.TagElementName, this.ConvertTagElement }, + { WixConverter.TagRefElementName, this.ConvertTagRefElement }, { WixConverter.TextElementName, this.ConvertTextElement }, { WixConverter.UITextElementName, this.ConvertUITextElement }, { WixConverter.VariableElementName, this.ConvertVariableElement }, @@ -686,13 +689,7 @@ namespace WixToolset.Converters private void ConvertApprovedExeForElevationElement(XElement element) { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } + this.RenameWin64ToBitness(element); } private void ConvertBalBootstrapperApplicationRef(XElement element, string theme, XName balBAElementName, XName oldBalBAElementName = null) @@ -897,13 +894,7 @@ namespace WixToolset.Converters } } - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } + this.RenameWin64ToBitness(element); } private void ConvertDirectoryElement(XElement element) @@ -1289,28 +1280,13 @@ namespace WixToolset.Converters this.OnError(ConverterTestType.BurnHashAlgorithmChanged, element, "The hash algorithm for bundles changed from SHA1 to SHA512."); - RemoveIfPresent(element.Attribute("CertificatePublicKey")); - RemoveIfPresent(element.Attribute("CertificateThumbprint")); - - void RemoveIfPresent(XAttribute xAttribute) - { - if (null != xAttribute - && this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The chain package element contains obsolete '{0}' attribute. Signature validation is no longer supported. The attribute will be removed.", xAttribute.Name)) - { - xAttribute.Remove(); - } - } + this.RemoveAttributeIfPresent(element, "CertificatePublicKey", ConverterTestType.BundleSignatureValidationObsolete, "The {0} element contains obsolete '{1}' attribute. Signature validation is no longer supported. The attribute will be removed."); + this.RemoveAttributeIfPresent(element, "CertificateThumbprint", ConverterTestType.BundleSignatureValidationObsolete, "The {0} element contains obsolete '{1}' attribute. Signature validation is no longer supported. The attribute will be removed."); } private void ConvertRegistrySearchElement(XElement element) { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } + this.RenameWin64ToBitness(element); } private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); @@ -1394,6 +1370,18 @@ namespace WixToolset.Converters { element.Name = SoftwareTagElementName; } + + this.RemoveAttributeIfPresent(element, "Licensed", ConverterTestType.SoftwareTagLicensedObsolete, "The {0} element contains obsolete '{1}' attribute. The attribute will be removed."); + this.RemoveAttributeIfPresent(element, "Type", ConverterTestType.SoftwareTagLicensedObsolete, "The {0} element contains obsolete '{1}' attribute. The attribute will be removed."); + this.RenameWin64ToBitness(element); + } + + private void ConvertTagRefElement(XElement element) + { + if (this.OnError(ConverterTestType.TagRefElementRenamed, element, "The TagRef element has been renamed. Use the 'SoftwareTagRef' element instead.")) + { + element.Name = SoftwareTagRefElementName; + } } private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); @@ -1543,13 +1531,7 @@ namespace WixToolset.Converters private void ConvertUtilRegistrySearchElement(XElement element) { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead.")) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } + this.RenameWin64ToBitness(element); if (this.SourceVersion < 4) { @@ -1593,6 +1575,26 @@ namespace WixToolset.Converters } } + void RemoveAttributeIfPresent(XElement element, string attributeName, ConverterTestType type, string format) + { + var xAttribute = element.Attribute(attributeName); + if (null != xAttribute && this.OnError(type, element, format, element.Name.LocalName, xAttribute.Name)) + { + xAttribute.Remove(); + } + } + + private void RenameWin64ToBitness(XElement element) + { + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The {0} element's Win64 attribute has been renamed. Use the Bitness attribute instead.", element.Name.LocalName)) + { + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); + win64.Remove(); + } + } + private string UpdateWin64ValueToBitnessValue(XAttribute xWin64Attribute) { var value = xWin64Attribute.Value ?? String.Empty; @@ -2185,6 +2187,21 @@ namespace WixToolset.Converters /// The RegistryKey element's Action attribute is obsolete. /// RegistryKeyActionObsolete, + + /// + /// The TagRef element has been renamed. Use the element 'SoftwareTagRef' name. + /// + TagRefElementRenamed, + + /// + /// The SoftwareTag element's Licensed attribute is obsolete. + /// + SoftwareTagLicensedObsolete, + + /// + /// The SoftwareTag element's Type attribute is obsolete. + /// + SoftwareTagTypeObsolete, } } } diff --git a/src/test/WixToolsetTest.Converters/TagFixture.cs b/src/test/WixToolsetTest.Converters/TagFixture.cs index c163ea11..5e07c83b 100644 --- a/src/test/WixToolsetTest.Converters/TagFixture.cs +++ b/src/test/WixToolsetTest.Converters/TagFixture.cs @@ -41,5 +41,71 @@ namespace WixToolsetTest.Converters var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); } + + [Fact] + public void FixTagExtensionDeprecations() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixTagExtensionTagRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } } } -- cgit v1.2.3-55-g6feb From 73e379d53076184d189a115ac1f5eb3d44d158df Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 3 Apr 2021 18:16:22 -0700 Subject: Integrate the IntermediateSection and IntermediateSymbol mutable changes --- src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index c2bc8d29..fd12dc2a 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -39,7 +39,7 @@ namespace WixToolset.Converters.Symbolizer var symbol = GenerateSymbolFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); if (symbol != null) { - section.Symbols.Add(symbol); + section.AddSymbol(symbol); } } } @@ -733,11 +733,13 @@ namespace WixToolset.Converters.Symbolizer private static IntermediateSymbol DefaultSymbolFromRow(Type symbolType, Wix3.Row row, bool columnZeroIsId) { - var symbol = Activator.CreateInstance(symbolType) as IntermediateSymbol; + var id = columnZeroIsId ? GetIdentifierForRow(row) : null; + + var createSymbol = symbolType.GetConstructor(new[] { typeof(SourceLineNumber), typeof(Identifier) }); + var symbol = (IntermediateSymbol)createSymbol.Invoke(new object[] { SourceLineNumber4(row.SourceLineNumbers), id }); SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); - symbol.SourceLineNumbers = SourceLineNumber4(row.SourceLineNumbers); return symbol; } @@ -747,7 +749,11 @@ namespace WixToolset.Converters.Symbolizer var fieldDefinitions = columnDefinitions.Select(columnDefinition => new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); var symbolDefinition = new IntermediateSymbolDefinition(row.Table.Name, fieldDefinitions, null); - var symbol = new IntermediateSymbol(symbolDefinition, SourceLineNumber4(row.SourceLineNumbers)); + + var id = columnZeroIsId ? GetIdentifierForRow(row) : null; + + var createSymbol = typeof(IntermediateSymbol).GetConstructor(new[] { typeof(IntermediateSymbolDefinition), typeof(SourceLineNumber), typeof(Identifier) }); + var symbol = (IntermediateSymbol)createSymbol.Invoke(new object[] { symbolDefinition, SourceLineNumber4(row.SourceLineNumbers), id }); SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); @@ -756,10 +762,9 @@ namespace WixToolset.Converters.Symbolizer private static void SetSymbolFieldsFromRow(Wix3.Row row, IntermediateSymbol symbol, bool columnZeroIsId) { - int offset = 0; + var offset = 0; if (columnZeroIsId) { - symbol.Id = GetIdentifierForRow(row); offset = 1; } -- cgit v1.2.3-55-g6feb From f4e79b704aa2eea60c57b4df45319ea57b9d3a53 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 3 Apr 2021 18:26:30 -0700 Subject: Integrate ImmediateSection no longer uses codepage --- src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs index fd12dc2a..6418b2a6 100644 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -22,7 +22,7 @@ namespace WixToolset.Converters.Symbolizer public static Intermediate ConvertOutput(Wix3.Output output) #pragma warning restore 1591 { - var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type), output.Codepage); + var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type)); var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); var componentsById = IndexById(output, "Component"); -- cgit v1.2.3-55-g6feb From 2031d4703e6a64ae1fff367beb7210b3587a0f28 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 3 Apr 2021 18:26:48 -0700 Subject: Standardize on .NET Core v3.1 --- src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj index 8b525497..29b02b95 100644 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -3,7 +3,7 @@ - netcoreapp2.1 + netcoreapp3.1 false -- cgit v1.2.3-55-g6feb From 0d29fa5d042d56517aaefb21f4fc512516039377 Mon Sep 17 00:00:00 2001 From: Ron Martin Date: Sun, 28 Mar 2021 23:29:37 -0400 Subject: Fix deprecated $(loc.xxx) localization variable references. Fixes wixtoolset/issues#6262 --- src/WixToolset.Converters/WixConverter.cs | 76 ++++++++++++++++++---- .../WixToolsetTest.Converters/ConverterFixture.cs | 38 +++++++++++ 2 files changed, 102 insertions(+), 12 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index b8f2a516..1ef57fe7 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -179,6 +179,8 @@ namespace WixToolset.Converters }; private readonly Dictionary> ConvertElementMapping; + private readonly Regex DeprecatedPrefixRegex = new Regex(@"(?<=(^|[^\$])(\$\$)*)\$(?=\(loc\.[^.].*\))", + RegexOptions.Compiled | RegexOptions.CultureInvariant | RegexOptions.ExplicitCapture); /// /// Instantiate a new Converter class. @@ -427,6 +429,13 @@ namespace WixToolset.Converters { if (node is XText text) { + if (null != text.Value) + { + if (this.TryFixDeprecatedLocalizationPrefixes(node, text.Value, out var newValue, ConverterTestType.DeprecatedLocalizationVariablePrefixInTextValue)) + { + text.Value = newValue; + } + } if (!String.IsNullOrWhiteSpace(text.Value)) { text.Value = text.Value.Trim(); @@ -464,6 +473,20 @@ namespace WixToolset.Converters } } + private bool TryFixDeprecatedLocalizationPrefixes(XNode node, string value, out string newValue, ConverterTestType testType) + { + newValue = this.DeprecatedPrefixRegex.Replace(value, "!"); + + if (object.ReferenceEquals(newValue, value)) + { + return false; + } + + var message = testType == ConverterTestType.DeprecatedLocalizationVariablePrefixInTextValue ? "The prefix on the localization variable in the inner text is incorrect." : "The prefix on the localization variable in the attribute value is incorrect."; + + return this.OnError(testType, node, message); + } + private void EnsurePrecedingWhitespaceCorrect(XText whitespace, XNode node, int level, ConverterTestType testType) { if (!WixConverter.LeadingWhitespaceValid(this.IndentationAmount, level, whitespace.Value)) @@ -492,25 +515,40 @@ namespace WixToolset.Converters private void ConvertElement(XElement element) { - // Gather any deprecated namespaces, then update this element tree based on those deprecations. var deprecatedToUpdatedNamespaces = new Dictionary(); - foreach (var declaration in element.Attributes().Where(a => a.IsNamespaceDeclaration)) + foreach (var attribute in element.Attributes()) { - if (element.Name == Wix3ElementName || element.Name == Include3ElementName) - { - this.SourceVersion = 3; - } - else if (element.Name == Wix4ElementName || element.Name == Include4ElementName) + if (attribute.IsNamespaceDeclaration) { - this.SourceVersion = 4; - } + // Gather any deprecated namespaces, then update this element tree based on those deprecations. + var declaration = attribute; - if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + if (element.Name == Wix3ElementName || element.Name == Include3ElementName) + { + this.SourceVersion = 3; + } + else if (element.Name == Wix4ElementName || element.Name == Include4ElementName) + { + this.SourceVersion = 4; + } + + if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + { + if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) + { + deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); + } + } + } + else { - if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) + if (null != attribute.Value) { - deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); + if (this.TryFixDeprecatedLocalizationPrefixes(element, attribute.Value, out var newValue, ConverterTestType.DeprecatedLocalizationVariablePrefixInAttributeValue)) + { + attribute.Value = newValue; + } } } } @@ -1958,11 +1996,15 @@ namespace WixToolset.Converters /// WhitespacePrecedingEndElementWrong, + // Before this point, ignore errors on convert operation + /// /// Displayed when the XML declaration is present in the source file. /// DeclarationPresent, + // After this point, ignore errors on format operation + /// /// Displayed when the xmlns attribute is missing from the document element. /// @@ -1973,6 +2015,16 @@ namespace WixToolset.Converters /// XmlnsValueWrong, + /// + /// Displayed when inner text contains a deprecated $(loc.xxx) reference. + /// + DeprecatedLocalizationVariablePrefixInTextValue, + + /// + /// Displayed when an attribute value contains a deprecated $(loc.xxx) reference. + /// + DeprecatedLocalizationVariablePrefixInAttributeValue, + /// /// Assign an identifier to a File element when on Id attribute is specified. /// diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 39521da0..13df9da7 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -407,5 +407,43 @@ namespace WixToolsetTest.Converters Assert.Equal(2, errors); Assert.Equal(expected, actual); } + + [Fact] + public void CanConvertDeprecatedPrefix() + { + var parse = String.Join(Environment.NewLine, + "", + "", + "", + "", + "", + "", + "", + "", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + "", + "", + "", + "", + "", + "", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(3, errors); + Assert.Equal(expected, actual); + } } } -- cgit v1.2.3-55-g6feb From 5df3b188583697ca6f3910224e2135e8bacc56f0 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 6 Apr 2021 13:30:49 -0700 Subject: Add StandardDirectory conversions Completes wixtoolset/issues#6416 --- src/WixToolset.Converters/WixConverter.cs | 63 ++++++++++++++- .../WixToolsetTest.Converters/DirectoryFixture.cs | 92 ++++++++++++++++++++++ 2 files changed, 154 insertions(+), 1 deletion(-) create mode 100644 src/test/WixToolsetTest.Converters/DirectoryFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 1ef57fe7..80784807 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -12,6 +12,7 @@ namespace WixToolset.Converters using System.Xml; using System.Xml.Linq; using WixToolset.Data; + using WixToolset.Data.WindowsInstaller; using WixToolset.Extensibility.Services; /// @@ -120,6 +121,7 @@ namespace WixToolset.Converters private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; private static readonly XName SoftwareTagElementName = WixNamespace + "SoftwareTag"; private static readonly XName SoftwareTagRefElementName = WixNamespace + "SoftwareTagRef"; + private static readonly XName StandardDirectoryElementName = WixNamespace + "StandardDirectory"; private static readonly XName TagElementName = XNamespace.None + "Tag"; private static readonly XName TagRefElementName = XNamespace.None + "TagRef"; private static readonly XName TextElementName = WixNamespace + "Text"; @@ -468,7 +470,18 @@ namespace WixToolset.Converters { this.ConvertElement(element); - this.ConvertNodes(element.Nodes(), level + 1); + var before = element.Nodes().ToList(); + + this.ConvertNodes(before, level + 1); + + // If any nodes were added during the processing of the children, + // ensure those added children get processed as well. + var added = element.Nodes().Except(before).ToList(); + + if (added.Any()) + { + this.ConvertNodes(added, level + 1); + } } } } @@ -950,6 +963,44 @@ namespace WixToolset.Converters } } } + + var id = element.Attribute("Id")?.Value; + + if (id == "TARGETDIR" && + this.OnError(ConverterTestType.TargetDirDeprecated, element, "The TARGETDIR directory should not longer be explicitly defined. Remove the Directory element with Id attribute 'TARGETDIR'.")) + { + var parentElement = element.Parent; + + element.Remove(); + + if (parentElement.FirstNode is XText text && String.IsNullOrWhiteSpace(text.Value)) + { + parentElement.FirstNode.Remove(); + } + + foreach (var child in element.Nodes()) + { + parentElement.Add(child); + } + + element.RemoveAll(); + + if (parentElement.FirstNode is XText textAgain && String.IsNullOrWhiteSpace(textAgain.Value)) + { + parentElement.FirstNode.Remove(); + } + } + else if (id != null && + WindowsInstallerStandard.IsStandardDirectory(id) && + this.OnError(ConverterTestType.DefiningStandardDirectoryDeprecated, element, "Standard directories such as '{0}' should no longer be defined using the Directory element. Use the StandardDirectory element instead.", id)) + { + element.Name = StandardDirectoryElementName; + + foreach (var attrib in element.Attributes().Where(a => a.Name.LocalName != "Id").ToList()) + { + attrib.Remove(); + } + } } private void ConvertFeatureElement(XElement element) @@ -2254,6 +2305,16 @@ namespace WixToolset.Converters /// The SoftwareTag element's Type attribute is obsolete. /// SoftwareTagTypeObsolete, + + /// + /// TARGETDIR directory should not longer be explicitly defined. + /// + TargetDirDeprecated, + + /// + /// Standard directories should no longer be defined using the Directory element. + /// + DefiningStandardDirectoryDeprecated, } } } diff --git a/src/test/WixToolsetTest.Converters/DirectoryFixture.cs b/src/test/WixToolsetTest.Converters/DirectoryFixture.cs new file mode 100644 index 00000000..3c906320 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/DirectoryFixture.cs @@ -0,0 +1,92 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class DirectoryFixture : BaseConverterFixture + { + [Fact] + public void RemoveTargetDir() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixStandardDirectory() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb From 5d19bfbf7c509dcb5461b0779f511b3b434b638b Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Mon, 19 Apr 2021 19:20:41 -0700 Subject: Integrate latest Extensibility changes --- src/WixToolset.Converters/ConverterExtensionCommandLine.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs index 8d740a3a..06d3658c 100644 --- a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs +++ b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs @@ -21,7 +21,7 @@ namespace WixToolset.Converters private IServiceProvider ServiceProvider { get; } - public override IEnumerable CommandLineSwitches => new ExtensionCommandLineSwitch[] + public override IReadOnlyCollection CommandLineSwitches => new ExtensionCommandLineSwitch[] { new ExtensionCommandLineSwitch { Switch = "convert", Description = "Convert v3 source code to v4 source code." }, new ExtensionCommandLineSwitch { Switch = "format", Description = "Ensures consistent formatting of source code." }, -- cgit v1.2.3-55-g6feb From b0840f6ad872f7085fd8d62285dc889763a65968 Mon Sep 17 00:00:00 2001 From: Ron Martin Date: Thu, 22 Apr 2021 18:46:03 -0400 Subject: Detect Inability to write to output file Fixes wixtoolset/issues#6425 --- src/WixToolset.Converters/WixConverter.cs | 20 ++++++++++-------- .../ConverterIntegrationFixture.cs | 24 ++++++++++++++++++++++ 2 files changed, 35 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 80784807..6080eeb9 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -1848,8 +1848,8 @@ namespace WixToolset.Converters { // Ignore the error if explicitly ignored or outside the range of the current operation. if (this.IgnoreErrors.Contains(converterTestType) || - (this.Operation == ConvertOperation.Convert && converterTestType < ConverterTestType.DeclarationPresent) || - (this.Operation == ConvertOperation.Format && converterTestType > ConverterTestType.DeclarationPresent)) + (this.Operation == ConvertOperation.Convert && converterTestType < ConverterTestType.EndIgnoreInConvert) || + (this.Operation == ConvertOperation.Format && converterTestType > ConverterTestType.BeginIgnoreInFormat)) { return false; } @@ -2032,11 +2032,6 @@ namespace WixToolset.Converters /// XmlException, - /// - /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. - /// - UnauthorizedAccessException, - /// /// Displayed when the whitespace preceding a node is wrong. /// @@ -2047,14 +2042,21 @@ namespace WixToolset.Converters /// WhitespacePrecedingEndElementWrong, - // Before this point, ignore errors on convert operation + /// Before this point, ignore errors on convert operation + EndIgnoreInConvert, /// /// Displayed when the XML declaration is present in the source file. /// DeclarationPresent, - // After this point, ignore errors on format operation + /// + /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. + /// + UnauthorizedAccessException, + + /// After this point, ignore errors on format operation + BeginIgnoreInFormat, /// /// Displayed when the xmlns attribute is missing from the document element. diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index cabc89ee..acd7991e 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -8,6 +8,7 @@ namespace WixToolsetTest.Converters using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolset.Core; + using WixToolset.Core.ExtensibilityServices; using WixToolset.Core.TestPackage; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -68,6 +69,29 @@ namespace WixToolsetTest.Converters } } + [Fact] + public void CanDetectReadOnlyOutputFile() + { + const string beforeFileName = "SingleFile.wxs"; + var folder = TestData.Get(@"TestData\SingleFile"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var info = new FileInfo(targetFile); + info.IsReadOnly = true; + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4); + var errors = converter.ConvertFile(targetFile, true); + + Assert.Equal(10, errors); + } + } + [Fact] public void RetainsPreprocessorInstructions() { -- cgit v1.2.3-55-g6feb From 0177cb5b9b08351266816097ea9e8561b9ec0973 Mon Sep 17 00:00:00 2001 From: Bob Arnson Date: Fri, 23 Apr 2021 17:50:54 -0400 Subject: Fix for added elements to reference platform-specific extension custom actions. --- src/WixToolset.Converters/WixConverter.cs | 113 +++++++++++++++++++++ .../ConverterIntegrationFixture.cs | 3 +- .../UtilExtensionFixture.cs | 75 ++++++++++++++ 3 files changed, 189 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 6080eeb9..e42d0605 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -105,6 +105,7 @@ namespace WixToolset.Converters private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; private static readonly XName ProductElementName = WixNamespace + "Product"; private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; + private static readonly XName PropertyRefElementName = WixNamespace + "PropertyRef"; private static readonly XName PublishElementName = WixNamespace + "Publish"; private static readonly XName ProvidesElementName = WixNamespace + "Provides"; private static readonly XName RequiresElementName = WixNamespace + "Requires"; @@ -138,6 +139,7 @@ namespace WixToolset.Converters private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; + private static readonly XName CustomActionRefElementName = WixNamespace + "CustomActionRef"; private static readonly XName PropertyElementName = WixNamespace + "Property"; private static readonly XName Wix4ElementName = WixNamespace + "Wix"; private static readonly XName Wix3ElementName = Wix3Namespace + "Wix"; @@ -230,12 +232,14 @@ namespace WixToolset.Converters { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, { WixConverter.ProductElementName, this.ConvertProductElement }, { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, + { WixConverter.PropertyRefElementName, this.ConvertPropertyRefElement }, { WixConverter.PublishElementName, this.ConvertPublishElement }, { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, { WixConverter.RegistryKeyElementName, this.ConvertRegistryKeyElement }, { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement }, { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, + { WixConverter.CustomActionRefElementName, this.ConvertCustomActionRefElement }, { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, @@ -1293,6 +1297,110 @@ namespace WixToolset.Converters xAttribute?.Remove(); } + private void ConvertPropertyRefElement(XElement element) + { + var newElementName = String.Empty; + + var id = element.Attribute("Id"); + switch (id?.Value) + { + case "WIX_SUITE_BACKOFFICE": + case "WIX_SUITE_BLADE": + case "WIX_SUITE_COMMUNICATIONS": + case "WIX_SUITE_COMPUTE_SERVER": + case "WIX_SUITE_DATACENTER": + case "WIX_SUITE_EMBEDDED_RESTRICTED": + case "WIX_SUITE_EMBEDDEDNT": + case "WIX_SUITE_ENTERPRISE": + case "WIX_SUITE_MEDIACENTER": + case "WIX_SUITE_PERSONAL": + case "WIX_SUITE_SECURITY_APPLIANCE": + case "WIX_SUITE_SERVERR2": + case "WIX_SUITE_SINGLEUSERTS": + case "WIX_SUITE_SMALLBUSINESS": + case "WIX_SUITE_SMALLBUSINESS_RESTRICTED": + case "WIX_SUITE_STARTER": + case "WIX_SUITE_STORAGE_SERVER": + case "WIX_SUITE_TABLETPC": + case "WIX_SUITE_TERMINAL": + case "WIX_SUITE_WH_SERVER": + newElementName = "QueryWindowsSuiteInfo"; + break; + case "WIX_DIR_ADMINTOOLS": + case "WIX_DIR_ALTSTARTUP": + case "WIX_DIR_CDBURN_AREA": + case "WIX_DIR_COMMON_ADMINTOOLS": + case "WIX_DIR_COMMON_ALTSTARTUP": + case "WIX_DIR_COMMON_DOCUMENTS": + case "WIX_DIR_COMMON_FAVORITES": + case "WIX_DIR_COMMON_MUSIC": + case "WIX_DIR_COMMON_PICTURES": + case "WIX_DIR_COMMON_VIDEO": + case "WIX_DIR_COOKIES": + case "WIX_DIR_DESKTOP": + case "WIX_DIR_HISTORY": + case "WIX_DIR_INTERNET_CACHE": + case "WIX_DIR_MYMUSIC": + case "WIX_DIR_MYPICTURES": + case "WIX_DIR_MYVIDEO": + case "WIX_DIR_NETHOOD": + case "WIX_DIR_PERSONAL": + case "WIX_DIR_PRINTHOOD": + case "WIX_DIR_PROFILE": + case "WIX_DIR_RECENT": + case "WIX_DIR_RESOURCES": + newElementName = "QueryWindowsDirectories"; + break; + case "WIX_DWM_COMPOSITION_ENABLED": + case "WIX_WDDM_DRIVER_PRESENT": + newElementName = "QueryWindowsDriverInfo"; + break; + case "WIX_ACCOUNT_LOCALSYSTEM": + case "WIX_ACCOUNT_LOCALSERVICE": + case "WIX_ACCOUNT_NETWORKSERVICE": + case "WIX_ACCOUNT_ADMINISTRATORS": + case "WIX_ACCOUNT_USERS": + case "WIX_ACCOUNT_GUESTS": + case "WIX_ACCOUNT_PERFLOGUSERS": + case "WIX_ACCOUNT_PERFLOGUSERS_NODOMAIN": + newElementName = "QueryWindowsWellKnownSIDs"; + break; + } + + if (!String.IsNullOrEmpty(newElementName) + && this.OnError(ConverterTestType.UtilReferencesReplaced, element, "Custom action and property reference {0} to WixUtilExtension have been replaced with strongly-typed elements.", id)) + { + element.AddAfterSelf(new XElement(WixUtilNamespace + newElementName)); + element.Remove(); + } + } + + private void ConvertCustomActionRefElement(XElement element) + { + var newElementName = String.Empty; + + var id = element.Attribute("Id"); + switch (id?.Value) + { + case "WixBroadcastSettingChange": + case "WixBroadcastEnvironmentChange": + case "WixCheckRebootRequired": + case "WixExitEarlyWithSuccess": + case "WixFailWhenDeferred": + case "WixWaitForEvent": + case "WixWaitForEventDeferred": + newElementName = id?.Value.Substring(3); // strip leading Wix + break; + } + + if (!String.IsNullOrEmpty(newElementName) + && this.OnError(ConverterTestType.UtilReferencesReplaced, element, "Custom action and property reference {0} to WixUtilExtension have been replaced with strongly-typed elements.", id)) + { + element.AddAfterSelf(new XElement(WixUtilNamespace + newElementName)); + element.Remove(); + } + } + private void ConvertPublishElement(XElement element) { this.ConvertInnerTextToAttribute(element, "Condition"); @@ -2317,6 +2425,11 @@ namespace WixToolset.Converters /// Standard directories should no longer be defined using the Directory element. /// DefiningStandardDirectoryDeprecated, + + /// + /// Naked custom action and property references replaced with WixUtilExtension elements. + /// + UtilReferencesReplaced, } } } diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs index acd7991e..a39f6243 100644 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -8,7 +8,6 @@ namespace WixToolsetTest.Converters using WixBuildTools.TestSupport; using WixToolset.Converters; using WixToolset.Core; - using WixToolset.Core.ExtensibilityServices; using WixToolset.Core.TestPackage; using WixToolsetTest.Converters.Mocks; using Xunit; @@ -88,7 +87,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 4); var errors = converter.ConvertFile(targetFile, true); - Assert.Equal(10, errors); + Assert.Single(messaging.Messages.Where(m => m.Id == 5/*WixConverter.ConverterTestType.UnauthorizedAccessException*/)); } } diff --git a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs index 9964e3b0..10450c68 100644 --- a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs +++ b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs @@ -111,5 +111,80 @@ namespace WixToolsetTest.Converters var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); } + + + [Fact] + public void FixXmlConfigValueCData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " b]]>", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixQueryOsPropertyRefs() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } } } -- cgit v1.2.3-55-g6feb From 612dc390ecd90bf4079ad7545f4a4832ce8f702d Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Tue, 27 Apr 2021 22:37:33 -0700 Subject: Move Converters into wix --- .editorconfig | 37 - README.md | 2 - WixToolset.Converters.sln | 85 - WixToolset.Converters.v3.ncrunchsolution | 6 - appveyor.cmd | 20 - appveyor.yml | 44 - nuget.config | 14 - src/.editorconfig | 37 + src/Directory.Build.props | 27 - src/Directory.Build.targets | 51 - src/Directory.csproj.props | 13 - src/Directory.csproj.targets | 26 - .../ConvertSymbols.cs | 876 ------- .../WixToolset.Converters.Symbolizer.csproj | 32 - src/WixToolset.Converters/ConvertCommand.cs | 60 - .../ConverterExtensionCommandLine.cs | 46 - .../ConverterExtensionFactory.cs | 30 - src/WixToolset.Converters/FixupCommandBase.cs | 288 --- src/WixToolset.Converters/FormatCommand.cs | 60 - src/WixToolset.Converters/WixConverter.cs | 2435 -------------------- .../WixToolset.Converters.csproj | 24 - .../WixToolsetCoreServiceProviderExtensions.cs | 25 - src/deps/wix.dll | Bin 1753088 -> 0 bytes .../ConvertSymbolsFixture.cs | 606 ----- .../TestData/Integration/test.wixout | Bin 148559 -> 0 bytes .../TestData/Integration/test.wixproj | 47 - .../TestData/Integration/test.wxs | 36 - .../WixToolsetTest.Converters.Symbolizer.csproj | 33 - ...setTest.Converters.Symbolizer.v3.ncrunchproject | 9 - .../BaseConverterFixture.cs | 33 - .../WixToolsetTest.Converters/BitnessFixture.cs | 187 -- .../BootstrapperApplicationFixture.cs | 418 ---- .../WixToolsetTest.Converters/ConditionFixture.cs | 297 --- .../WixToolsetTest.Converters/ConverterFixture.cs | 449 ---- .../ConverterIntegrationFixture.cs | 195 -- .../CustomActionFixture.cs | 88 - .../CustomTableFixture.cs | 363 --- .../WixToolsetTest.Converters/DependencyFixture.cs | 178 -- .../WixToolsetTest.Converters/DirectoryFixture.cs | 92 - .../WixToolsetTest.Converters/ExePackageFixture.cs | 49 - .../WixToolsetTest.Converters/FeatureFixture.cs | 110 - .../FirewallExtensionFixture.cs | 47 - .../WixToolsetTest.Converters/FormatFixture.cs | 117 - .../WixToolsetTest.Converters/IncludeFixture.cs | 68 - .../Mocks/MockCoreServiceProvider.cs | 51 - .../Mocks/MockMessaging.cs | 39 - .../ProductPackageFixture.cs | 278 --- .../WixToolsetTest.Converters/PropertyFixture.cs | 108 - .../WixToolsetTest.Converters/RegistryFixture.cs | 54 - .../RemotePayloadFixture.cs | 104 - .../WixToolsetTest.Converters/SequenceFixture.cs | 49 - src/test/WixToolsetTest.Converters/TagFixture.cs | 111 - .../PackageSummaryInformation/TypicalV3.msi | Bin 32768 -> 0 bytes .../PackageSummaryInformation/TypicalV3.wxs | 37 - .../TestData/PermissionEx/v3.wxs | 26 - .../TestData/PermissionEx/v4_expected.wxs | 26 - .../Preprocessor/ConvertedPreprocessor.wxs | 61 - .../TestData/Preprocessor/Preprocessor.wxs | 63 - .../TestData/Preprocessor/wixcop.settings.xml | 9 - .../TestData/QtExec.bad/v3.wxs | 64 - .../TestData/QtExec.bad/v4_expected.wxs | 63 - .../TestData/QtExec/v3.wxs | 64 - .../TestData/QtExec/v4_expected.wxs | 62 - .../TestData/SingleFile/ConvertedSingleFile.wxs | 59 - .../TestData/SingleFile/SingleFile.wxs | 61 - .../UtilExtensionFixture.cs | 190 -- .../WixToolsetTest.Converters/VariableFixture.cs | 86 - .../Wix4ConversionFixture.cs | 54 - .../WixToolsetTest.Converters.csproj | 31 - src/version.json | 11 + src/wix/Directory.Build.props | 27 + src/wix/Directory.Build.targets | 51 + src/wix/Directory.csproj.props | 13 + src/wix/Directory.csproj.targets | 26 + src/wix/README.md | 2 + .../ConvertSymbols.cs | 876 +++++++ .../WixToolset.Converters.Symbolizer.csproj | 32 + src/wix/WixToolset.Converters.sln | 85 + src/wix/WixToolset.Converters.v3.ncrunchsolution | 6 + src/wix/WixToolset.Converters/ConvertCommand.cs | 60 + .../ConverterExtensionCommandLine.cs | 46 + .../ConverterExtensionFactory.cs | 30 + src/wix/WixToolset.Converters/FixupCommandBase.cs | 288 +++ src/wix/WixToolset.Converters/FormatCommand.cs | 60 + src/wix/WixToolset.Converters/WixConverter.cs | 2435 ++++++++++++++++++++ .../WixToolset.Converters.csproj | 24 + .../WixToolsetCoreServiceProviderExtensions.cs | 25 + src/wix/appveyor.cmd | 20 + src/wix/appveyor.yml | 44 + src/wix/deps/wix.dll | Bin 0 -> 1753088 bytes src/wix/nuget.config | 14 + .../ConvertSymbolsFixture.cs | 606 +++++ .../TestData/Integration/test.wixout | Bin 0 -> 148559 bytes .../TestData/Integration/test.wixproj | 47 + .../TestData/Integration/test.wxs | 36 + .../WixToolsetTest.Converters.Symbolizer.csproj | 33 + ...setTest.Converters.Symbolizer.v3.ncrunchproject | 9 + .../BaseConverterFixture.cs | 33 + .../WixToolsetTest.Converters/BitnessFixture.cs | 187 ++ .../BootstrapperApplicationFixture.cs | 418 ++++ .../WixToolsetTest.Converters/ConditionFixture.cs | 297 +++ .../WixToolsetTest.Converters/ConverterFixture.cs | 449 ++++ .../ConverterIntegrationFixture.cs | 195 ++ .../CustomActionFixture.cs | 88 + .../CustomTableFixture.cs | 363 +++ .../WixToolsetTest.Converters/DependencyFixture.cs | 178 ++ .../WixToolsetTest.Converters/DirectoryFixture.cs | 92 + .../WixToolsetTest.Converters/ExePackageFixture.cs | 49 + .../WixToolsetTest.Converters/FeatureFixture.cs | 110 + .../FirewallExtensionFixture.cs | 47 + .../WixToolsetTest.Converters/FormatFixture.cs | 117 + .../WixToolsetTest.Converters/IncludeFixture.cs | 68 + .../Mocks/MockCoreServiceProvider.cs | 51 + .../Mocks/MockMessaging.cs | 39 + .../ProductPackageFixture.cs | 278 +++ .../WixToolsetTest.Converters/PropertyFixture.cs | 108 + .../WixToolsetTest.Converters/RegistryFixture.cs | 54 + .../RemotePayloadFixture.cs | 104 + .../WixToolsetTest.Converters/SequenceFixture.cs | 49 + .../test/WixToolsetTest.Converters/TagFixture.cs | 111 + .../PackageSummaryInformation/TypicalV3.msi | Bin 0 -> 32768 bytes .../PackageSummaryInformation/TypicalV3.wxs | 37 + .../TestData/PermissionEx/v3.wxs | 26 + .../TestData/PermissionEx/v4_expected.wxs | 26 + .../Preprocessor/ConvertedPreprocessor.wxs | 61 + .../TestData/Preprocessor/Preprocessor.wxs | 63 + .../TestData/Preprocessor/wixcop.settings.xml | 9 + .../TestData/QtExec.bad/v3.wxs | 64 + .../TestData/QtExec.bad/v4_expected.wxs | 63 + .../TestData/QtExec/v3.wxs | 64 + .../TestData/QtExec/v4_expected.wxs | 62 + .../TestData/SingleFile/ConvertedSingleFile.wxs | 59 + .../TestData/SingleFile/SingleFile.wxs | 61 + .../UtilExtensionFixture.cs | 190 ++ .../WixToolsetTest.Converters/VariableFixture.cs | 86 + .../Wix4ConversionFixture.cs | 54 + .../WixToolsetTest.Converters.csproj | 31 + version.json | 11 - 138 files changed, 9384 insertions(+), 9384 deletions(-) delete mode 100644 .editorconfig delete mode 100644 README.md delete mode 100644 WixToolset.Converters.sln delete mode 100644 WixToolset.Converters.v3.ncrunchsolution delete mode 100644 appveyor.cmd delete mode 100644 appveyor.yml delete mode 100644 nuget.config create mode 100644 src/.editorconfig delete mode 100644 src/Directory.Build.props delete mode 100644 src/Directory.Build.targets delete mode 100644 src/Directory.csproj.props delete mode 100644 src/Directory.csproj.targets delete mode 100644 src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs delete mode 100644 src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj delete mode 100644 src/WixToolset.Converters/ConvertCommand.cs delete mode 100644 src/WixToolset.Converters/ConverterExtensionCommandLine.cs delete mode 100644 src/WixToolset.Converters/ConverterExtensionFactory.cs delete mode 100644 src/WixToolset.Converters/FixupCommandBase.cs delete mode 100644 src/WixToolset.Converters/FormatCommand.cs delete mode 100644 src/WixToolset.Converters/WixConverter.cs delete mode 100644 src/WixToolset.Converters/WixToolset.Converters.csproj delete mode 100644 src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs delete mode 100644 src/deps/wix.dll delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj delete mode 100644 src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject delete mode 100644 src/test/WixToolsetTest.Converters/BaseConverterFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/BitnessFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/ConditionFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/ConverterFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/CustomActionFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/CustomTableFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/DependencyFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/DirectoryFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/ExePackageFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/FeatureFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/FormatFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/IncludeFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs delete mode 100644 src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs delete mode 100644 src/test/WixToolsetTest.Converters/ProductPackageFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/PropertyFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/RegistryFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/SequenceFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/TagFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi delete mode 100644 src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs delete mode 100644 src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs delete mode 100644 src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/VariableFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs delete mode 100644 src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj create mode 100644 src/version.json create mode 100644 src/wix/Directory.Build.props create mode 100644 src/wix/Directory.Build.targets create mode 100644 src/wix/Directory.csproj.props create mode 100644 src/wix/Directory.csproj.targets create mode 100644 src/wix/README.md create mode 100644 src/wix/WixToolset.Converters.Symbolizer/ConvertSymbols.cs create mode 100644 src/wix/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj create mode 100644 src/wix/WixToolset.Converters.sln create mode 100644 src/wix/WixToolset.Converters.v3.ncrunchsolution create mode 100644 src/wix/WixToolset.Converters/ConvertCommand.cs create mode 100644 src/wix/WixToolset.Converters/ConverterExtensionCommandLine.cs create mode 100644 src/wix/WixToolset.Converters/ConverterExtensionFactory.cs create mode 100644 src/wix/WixToolset.Converters/FixupCommandBase.cs create mode 100644 src/wix/WixToolset.Converters/FormatCommand.cs create mode 100644 src/wix/WixToolset.Converters/WixConverter.cs create mode 100644 src/wix/WixToolset.Converters/WixToolset.Converters.csproj create mode 100644 src/wix/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs create mode 100644 src/wix/appveyor.cmd create mode 100644 src/wix/appveyor.yml create mode 100644 src/wix/deps/wix.dll create mode 100644 src/wix/nuget.config create mode 100644 src/wix/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout create mode 100644 src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj create mode 100644 src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj create mode 100644 src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject create mode 100644 src/wix/test/WixToolsetTest.Converters/BaseConverterFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/BitnessFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/ConditionFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/ConverterFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/CustomActionFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/CustomTableFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/DependencyFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/DirectoryFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/ExePackageFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/FeatureFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/FormatFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/IncludeFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/ProductPackageFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/PropertyFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/RegistryFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/RemotePayloadFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/SequenceFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/TagFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs create mode 100644 src/wix/test/WixToolsetTest.Converters/UtilExtensionFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/VariableFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs create mode 100644 src/wix/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj delete mode 100644 version.json (limited to 'src') diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 1d72e683..00000000 --- a/.editorconfig +++ /dev/null @@ -1,37 +0,0 @@ -# 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. -# -# Do NOT modify this file. Update the canonical version in Home\repo-template\src\.editorconfig -# then update all of the repos. - -root = true - -[*] -charset = utf-8 -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true - -[*.{cs,vb}] -dotnet_sort_system_directives_first = true - -[*.cs] -csharp_indent_case_contents = true : error -csharp_indent_switch_labels = true : error -csharp_new_line_before_open_brace = all -csharp_prefer_braces = true : error -csharp_style_expression_bodied_methods = when_on_single_line : suggestion -csharp_style_expression_bodied_constructors = when_on_single_line : suggestion -csharp_style_expression_bodied_operators = when_on_single_line : suggestion -csharp_style_expression_bodied_properties = when_on_single_line : suggestion -csharp_style_expression_bodied_indexers = when_on_single_line : suggestion -csharp_style_expression_bodied_accessors = when_on_single_line : suggestion -csharp_style_var_elsewhere = true : suggestion -csharp_style_var_for_built_in_types = true : suggestion -csharp_style_var_when_type_is_apparent = true : suggestion -dotnet_style_qualification_for_event = true : error -dotnet_style_qualification_for_field = true : error -dotnet_style_qualification_for_method = true : error -dotnet_style_qualification_for_property = true : error - -[*.targets] -indent_size = 2 diff --git a/README.md b/README.md deleted file mode 100644 index f031cf7c..00000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Converters -WixToolset.Converters, conversion related functionality diff --git a/WixToolset.Converters.sln b/WixToolset.Converters.sln deleted file mode 100644 index a67df266..00000000 --- a/WixToolset.Converters.sln +++ /dev/null @@ -1,85 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 15 -VisualStudioVersion = 15.0.26124.0 -MinimumVisualStudioVersion = 15.0.26124.0 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters", "src\WixToolset.Converters\WixToolset.Converters.csproj", "{6FAF6385-6598-4B89-972B-C31AFCA14538}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters.Symbolizer", "src\WixToolset.Converters.Symbolizer\WixToolset.Converters.Symbolizer.csproj", "{F051BCAF-698C-41D5-8427-164537CE5C5C}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters", "src\test\WixToolsetTest.Converters\WixToolsetTest.Converters.csproj", "{485C5038-97E1-4729-A54D-848CC69569FD}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters.Symbolizer", "src\test\WixToolsetTest.Converters.Symbolizer\WixToolsetTest.Converters.Symbolizer.csproj", "{9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Debug|x64 = Debug|x64 - Debug|x86 = Debug|x86 - Release|Any CPU = Release|Any CPU - Release|x64 = Release|x64 - Release|x86 = Release|x86 - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|Any CPU.Build.0 = Debug|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x64.ActiveCfg = Debug|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x64.Build.0 = Debug|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x86.ActiveCfg = Debug|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x86.Build.0 = Debug|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|Any CPU.ActiveCfg = Release|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|Any CPU.Build.0 = Release|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x64.ActiveCfg = Release|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x64.Build.0 = Release|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x86.ActiveCfg = Release|Any CPU - {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x86.Build.0 = Release|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x64.ActiveCfg = Debug|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x64.Build.0 = Debug|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x86.ActiveCfg = Debug|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x86.Build.0 = Debug|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|Any CPU.Build.0 = Release|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x64.ActiveCfg = Release|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x64.Build.0 = Release|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x86.ActiveCfg = Release|Any CPU - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x86.Build.0 = Release|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|Any CPU.Build.0 = Debug|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x64.ActiveCfg = Debug|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x64.Build.0 = Debug|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x86.ActiveCfg = Debug|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x86.Build.0 = Debug|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|Any CPU.ActiveCfg = Release|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|Any CPU.Build.0 = Release|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x64.ActiveCfg = Release|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x64.Build.0 = Release|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x86.ActiveCfg = Release|Any CPU - {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x86.Build.0 = Release|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|Any CPU.Build.0 = Debug|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x64.ActiveCfg = Debug|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x64.Build.0 = Debug|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x86.ActiveCfg = Debug|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x86.Build.0 = Debug|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Release|Any CPU.ActiveCfg = Release|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Release|Any CPU.Build.0 = Release|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x64.ActiveCfg = Release|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x64.Build.0 = Release|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x86.ActiveCfg = Release|Any CPU - {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x86.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C} = {1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E} - {485C5038-97E1-4729-A54D-848CC69569FD} = {1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E} - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {2E71F0EC-CF75-44DA-8353-7066EBD06564} - EndGlobalSection -EndGlobal diff --git a/WixToolset.Converters.v3.ncrunchsolution b/WixToolset.Converters.v3.ncrunchsolution deleted file mode 100644 index f774ab93..00000000 --- a/WixToolset.Converters.v3.ncrunchsolution +++ /dev/null @@ -1,6 +0,0 @@ - - - False - True - - \ No newline at end of file diff --git a/appveyor.cmd b/appveyor.cmd deleted file mode 100644 index 02db695b..00000000 --- a/appveyor.cmd +++ /dev/null @@ -1,20 +0,0 @@ -@setlocal -@pushd %~dp0 -@set _P=%~dp0build\Release\publish -@set _C=Release -@if /i "%1"=="debug" set _C=Debug - -:: Restore -msbuild -p:Configuration=%_C% -t:Restore || exit /b - -:: Build -msbuild -p:Configuration=%_C% || exit /b - -:: Test -dotnet test -c %_C% --no-build || exit /b - -:: Pack -msbuild -p:Configuration=%_C% -p:NoBuild=true -t:Pack || exit /b - -@popd -@endlocal diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 364569cf..00000000 --- a/appveyor.yml +++ /dev/null @@ -1,44 +0,0 @@ -# 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. -# -# Do NOT modify this file. Update the canonical version in Home\repo-template\src\appveyor.yml -# then update all of the repos. - -branches: - only: - - master - - develop - -image: Visual Studio 2019 - -version: 0.0.0.{build} -configuration: Release - -environment: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - DOTNET_CLI_TELEMETRY_OPTOUT: 1 - NUGET_XMLDOC_MODE: skip - -build_script: - - appveyor.cmd - -test: off - -pull_requests: - do_not_increment_build_number: true - -nuget: - disable_publish_on_pr: true - -skip_branch_with_pr: true -skip_tags: true - -artifacts: -- path: build\Release\**\*.nupkg - name: nuget -- path: build\Release\**\*.snupkg - name: snupkg - -notifications: -- provider: Slack - incoming_webhook: - secure: p5xuu+4x2JHfwGDMDe5KcG1k7gZxqYc4jWVwvyNZv5cvkubPD2waJs5yXMAXZNN7Z63/3PWHb7q4KoY/99AjauYa1nZ4c5qYqRPFRBKTHfA= diff --git a/nuget.config b/nuget.config deleted file mode 100644 index 31435a21..00000000 --- a/nuget.config +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - \ No newline at end of file diff --git a/src/.editorconfig b/src/.editorconfig new file mode 100644 index 00000000..1d72e683 --- /dev/null +++ b/src/.editorconfig @@ -0,0 +1,37 @@ +# 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. +# +# Do NOT modify this file. Update the canonical version in Home\repo-template\src\.editorconfig +# then update all of the repos. + +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +trim_trailing_whitespace = true + +[*.{cs,vb}] +dotnet_sort_system_directives_first = true + +[*.cs] +csharp_indent_case_contents = true : error +csharp_indent_switch_labels = true : error +csharp_new_line_before_open_brace = all +csharp_prefer_braces = true : error +csharp_style_expression_bodied_methods = when_on_single_line : suggestion +csharp_style_expression_bodied_constructors = when_on_single_line : suggestion +csharp_style_expression_bodied_operators = when_on_single_line : suggestion +csharp_style_expression_bodied_properties = when_on_single_line : suggestion +csharp_style_expression_bodied_indexers = when_on_single_line : suggestion +csharp_style_expression_bodied_accessors = when_on_single_line : suggestion +csharp_style_var_elsewhere = true : suggestion +csharp_style_var_for_built_in_types = true : suggestion +csharp_style_var_when_type_is_apparent = true : suggestion +dotnet_style_qualification_for_event = true : error +dotnet_style_qualification_for_field = true : error +dotnet_style_qualification_for_method = true : error +dotnet_style_qualification_for_property = true : error + +[*.targets] +indent_size = 2 diff --git a/src/Directory.Build.props b/src/Directory.Build.props deleted file mode 100644 index b3c6287c..00000000 --- a/src/Directory.Build.props +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - Debug - false - MSB3246 - - $(MSBuildProjectName) - $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)..\build\)) - $(BaseOutputPath)obj\$(ProjectName)\ - $(BaseOutputPath)$(Configuration)\ - - WiX Toolset Team - WiX Toolset - Copyright (c) .NET Foundation and contributors. All rights reserved. - MS-RL - WiX Toolset - - - - - diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets deleted file mode 100644 index 2fcc765a..00000000 --- a/src/Directory.Build.targets +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - true - $(SolutionPath) - $(NCrunchOriginalSolutionPath) - - - - - - - $([System.IO.File]::ReadAllText($(TheSolutionPath))) - $([System.IO.Path]::GetDirectoryName( $(TheSolutionPath) )) - (?<="[PackageName]", ")(.*)(?=", ") - - - - - - %(Identity) - $(SolutionFileContent.Contains('\%(Identity).csproj')) - - - - - $(RegexPattern.Replace('[PackageName]','%(PackageName)') ) - $([System.Text.RegularExpressions.Regex]::Match('$(SolutionFileContent)', '%(Pattern)')) - - - - - - - - - - - - - - diff --git a/src/Directory.csproj.props b/src/Directory.csproj.props deleted file mode 100644 index 81d24ad1..00000000 --- a/src/Directory.csproj.props +++ /dev/null @@ -1,13 +0,0 @@ - - - - - true - true - $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk)) - false - - diff --git a/src/Directory.csproj.targets b/src/Directory.csproj.targets deleted file mode 100644 index c3270426..00000000 --- a/src/Directory.csproj.targets +++ /dev/null @@ -1,26 +0,0 @@ - - - - - false - $(OutputPath)\$(AssemblyName).xml - - - - - $(PrivateRepositoryUrl.Replace('.git','')) - - $(MSBuildProjectName).nuspec - $(OutputPath)..\ - $(NuspecProperties);Id=$(PackageId);Authors=$(Authors);Copyright=$(Copyright);Description=$(Description);Title=$(Title) - $(NuspecProperties);Version=$(PackageVersion);RepositoryCommit=$(SourceRevisionId);RepositoryType=$(RepositoryType);RepositoryUrl=$(PrivateRepositoryUrl);ProjectFolder=$(MSBuildProjectDirectory)\;ProjectUrl=$(ProjectUrl) - true - snupkg - - - - diff --git a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs deleted file mode 100644 index 6418b2a6..00000000 --- a/src/WixToolset.Converters.Symbolizer/ConvertSymbols.cs +++ /dev/null @@ -1,876 +0,0 @@ -// 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.Converters.Symbolizer -{ - using System; - using System.Collections.Generic; - using System.Linq; - using WixToolset.Data; - using WixToolset.Data.Symbols; - using WixToolset.Data.WindowsInstaller; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - -#pragma warning disable 1591 // TODO: add documentation - public static class ConvertSymbols - { - public static Intermediate ConvertFile(string path) - { - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - return ConvertOutput(output); - } - - public static Intermediate ConvertOutput(Wix3.Output output) -#pragma warning restore 1591 - { - var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type)); - - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - var componentsById = IndexById(output, "Component"); - var bindPathsById = IndexById(output, "BindPath"); - var fontsById = IndexById(output, "Font"); - var selfRegById = IndexById(output, "SelfReg"); - var wixDirectoryById = IndexById(output, "WixDirectory"); - var wixFileById = IndexById(output, "WixFile"); - - foreach (Wix3.Table table in output.Tables) - { - foreach (Wix3.Row row in table.Rows) - { - var symbol = GenerateSymbolFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); - if (symbol != null) - { - section.AddSymbol(symbol); - } - } - } - - return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add(FieldAsInt(row, 0), row); - } - } - - return wixMediaByDiskId; - } - - private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row - { - var byId = new Dictionary(); - var table = output.Tables[tableName]; - - if (table != null) - { - foreach (T row in table.Rows) - { - byId.Add(FieldAsString(row, 0), row); - } - } - - return byId; - } - - private static IntermediateSymbol GenerateSymbolFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) - { - var name = row.Table.Name; - switch (name) - { - case "_SummaryInformation": - return DefaultSymbolFromRow(typeof(SummaryInformationSymbol), row, columnZeroIsId: false); - case "ActionText": - return DefaultSymbolFromRow(typeof(ActionTextSymbol), row, columnZeroIsId: false); - case "AppId": - return DefaultSymbolFromRow(typeof(AppIdSymbol), row, columnZeroIsId: false); - case "AppSearch": - return DefaultSymbolFromRow(typeof(AppSearchSymbol), row, columnZeroIsId: false); - case "Billboard": - return DefaultSymbolFromRow(typeof(BillboardSymbol), row, columnZeroIsId: true); - case "Binary": - return DefaultSymbolFromRow(typeof(BinarySymbol), row, columnZeroIsId: true); - case "BindPath": - return null; - case "CCPSearch": - return DefaultSymbolFromRow(typeof(CCPSearchSymbol), row, columnZeroIsId: true); - case "Class": - return DefaultSymbolFromRow(typeof(ClassSymbol), row, columnZeroIsId: false); - case "CompLocator": - return DefaultSymbolFromRow(typeof(CompLocatorSymbol), row, columnZeroIsId: false); - case "Component": - { - var attributes = FieldAsNullableInt(row, 3); - - var location = ComponentLocation.LocalOnly; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) - { - location = ComponentLocation.SourceOnly; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) - { - location = ComponentLocation.Either; - } - - var keyPath = FieldAsString(row, 5); - var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; - if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) - { - keyPathType = ComponentKeyPathType.Registry; - } - else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) - { - keyPathType = ComponentKeyPathType.OdbcDataSource; - } - - return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - ComponentId = FieldAsString(row, 1), - DirectoryRef = FieldAsString(row, 2), - Condition = FieldAsString(row, 4), - KeyPath = keyPath, - Location = location, - DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, - NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, - Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, - SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, - Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, - Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, - UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, - Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, - KeyPathType = keyPathType, - }; - } - - case "Condition": - return DefaultSymbolFromRow(typeof(ConditionSymbol), row, columnZeroIsId: false); - case "CreateFolder": - return DefaultSymbolFromRow(typeof(CreateFolderSymbol), row, columnZeroIsId: false); - case "CustomAction": - { - var caType = FieldAsInt(row, 1); - var executionType = DetermineCustomActionExecutionType(caType); - var sourceType = DetermineCustomActionSourceType(caType); - var targetType = DetermineCustomActionTargetType(caType); - - return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - ExecutionType = executionType, - SourceType = sourceType, - Source = FieldAsString(row, 2), - TargetType = targetType, - Target = FieldAsString(row, 3), - Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, - TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, - Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, - IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, - Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, - Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, - }; - } - - case "Directory": - { - var id = FieldAsString(row, 0); - var splits = SplitDefaultDir(FieldAsString(row, 2)); - - var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, id)) - { - ParentDirectoryRef = FieldAsString(row, 1), - Name = splits[0], - ShortName = splits[1], - SourceName = splits[2], - SourceShortName = splits[3] - }; - - if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) - { - symbol.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); - } - - return symbol; - } - case "DrLocator": - return DefaultSymbolFromRow(typeof(DrLocatorSymbol), row, columnZeroIsId: false); - case "DuplicateFile": - { - var splitName = FieldAsString(row, 3)?.Split('|'); - - var symbol = new DuplicateFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - ComponentRef = FieldAsString(row, 1), - FileRef = FieldAsString(row, 2), - DestinationName = splitName == null ? null : splitName.Length > 1 ? splitName[1] : splitName[0], - DestinationShortName = splitName == null ? null : splitName.Length > 1 ? splitName[0] : null, - DestinationFolder = FieldAsString(row, 4) - }; - - return symbol; - } - case "Error": - return DefaultSymbolFromRow(typeof(ErrorSymbol), row, columnZeroIsId: false); - case "Extension": - return DefaultSymbolFromRow(typeof(ExtensionSymbol), row, columnZeroIsId: false); - case "Feature": - { - var attributes = FieldAsInt(row, 7); - var installDefault = FeatureInstallDefault.Local; - if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) - { - installDefault = FeatureInstallDefault.FollowParent; - } - else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) - { - installDefault = FeatureInstallDefault.Source; - } - - return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - ParentFeatureRef = FieldAsString(row, 1), - Title = FieldAsString(row, 2), - Description = FieldAsString(row, 3), - Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), - Level = FieldAsInt(row, 5), - DirectoryRef = FieldAsString(row, 6), - DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, - DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, - InstallDefault = installDefault, - TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, - }; - } - - case "FeatureComponents": - return DefaultSymbolFromRow(typeof(FeatureComponentsSymbol), row, columnZeroIsId: false); - case "File": - { - var attributes = FieldAsNullableInt(row, 6); - - FileSymbolAttributes symbolAttributes = 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileSymbolAttributes.ReadOnly : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileSymbolAttributes.Hidden : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileSymbolAttributes.System : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileSymbolAttributes.Vital : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileSymbolAttributes.Checksum : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileSymbolAttributes.Uncompressed : 0; - symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileSymbolAttributes.Compressed : 0; - - var id = FieldAsString(row, 0); - var splitName = FieldAsString(row, 2).Split('|'); - - var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, id)) - { - ComponentRef = FieldAsString(row, 1), - Name = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortName = splitName.Length > 1 ? splitName[0] : null, - FileSize = FieldAsInt(row, 3), - Version = FieldAsString(row, 4), - Language = FieldAsString(row, 5), - Attributes = symbolAttributes - }; - - if (bindPathsById.TryGetValue(id, out var bindPathRow)) - { - symbol.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; - } - - if (fontsById.TryGetValue(id, out var fontRow)) - { - symbol.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; - } - - if (selfRegById.TryGetValue(id, out var selfRegRow)) - { - symbol.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; - } - - if (wixFileById.TryGetValue(id, out var wixFileRow)) - { - symbol.DirectoryRef = FieldAsString(wixFileRow, 4); - symbol.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; - symbol.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; - symbol.PatchGroup = FieldAsInt(wixFileRow, 8); - symbol.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); - } - - return symbol; - } - case "Font": - return null; - case "Icon": - return DefaultSymbolFromRow(typeof(IconSymbol), row, columnZeroIsId: true); - case "IniFile": - { - var splitName = FieldAsString(row, 1).Split('|'); - var action = FieldAsInt(row, 6); - - var symbol = new IniFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - FileName = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortFileName = splitName.Length > 1 ? splitName[0] : null, - DirProperty = FieldAsString(row, 2), - Section = FieldAsString(row, 3), - Key = FieldAsString(row, 4), - Value = FieldAsString(row, 5), - Action = action == 3 ? IniFileActionType.AddTag : action == 1 ? IniFileActionType.CreateLine : IniFileActionType.AddLine, - ComponentRef = FieldAsString(row, 7), - }; - - return symbol; - } - case "IniLocator": - { - var splitName = FieldAsString(row, 1).Split('|'); - - var symbol = new IniLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - FileName = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortFileName = splitName.Length > 1 ? splitName[0] : null, - Section = FieldAsString(row, 2), - Key = FieldAsString(row, 3), - Field = FieldAsInt(row, 4), - Type = FieldAsInt(row, 5), - }; - - return symbol; - } - case "LockPermissions": - return DefaultSymbolFromRow(typeof(LockPermissionsSymbol), row, columnZeroIsId: false); - case "Media": - { - var diskId = FieldAsInt(row, 0); - var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, diskId)) - { - DiskId = diskId, - LastSequence = FieldAsNullableInt(row, 1), - DiskPrompt = FieldAsString(row, 2), - Cabinet = FieldAsString(row, 3), - VolumeLabel = FieldAsString(row, 4), - Source = FieldAsString(row, 5) - }; - - if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) - { - var compressionLevel = FieldAsString(wixMediaRow, 1); - - symbol.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); - symbol.Layout = wixMediaRow.Layout; - } - - return symbol; - } - case "MIME": - return DefaultSymbolFromRow(typeof(MIMESymbol), row, columnZeroIsId: false); - case "ModuleIgnoreTable": - return DefaultSymbolFromRow(typeof(ModuleIgnoreTableSymbol), row, columnZeroIsId: true); - case "MoveFile": - return DefaultSymbolFromRow(typeof(MoveFileSymbol), row, columnZeroIsId: true); - case "MsiAssembly": - { - var componentId = FieldAsString(row, 0); - if (componentsById.TryGetValue(componentId, out var componentRow)) - { - return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(componentRow, 5))) - { - ComponentRef = componentId, - FeatureRef = FieldAsString(row, 1), - ManifestFileRef = FieldAsString(row, 2), - ApplicationFileRef = FieldAsString(row, 3), - Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, - }; - } - - return null; - } - case "MsiLockPermissionsEx": - return DefaultSymbolFromRow(typeof(MsiLockPermissionsExSymbol), row, columnZeroIsId: true); - case "MsiShortcutProperty": - return DefaultSymbolFromRow(typeof(MsiShortcutPropertySymbol), row, columnZeroIsId: true); - case "ODBCDataSource": - return DefaultSymbolFromRow(typeof(ODBCDataSourceSymbol), row, columnZeroIsId: true); - case "ODBCDriver": - return DefaultSymbolFromRow(typeof(ODBCDriverSymbol), row, columnZeroIsId: true); - case "ODBCTranslator": - return DefaultSymbolFromRow(typeof(ODBCTranslatorSymbol), row, columnZeroIsId: true); - case "ProgId": - return DefaultSymbolFromRow(typeof(ProgIdSymbol), row, columnZeroIsId: false); - case "Property": - return DefaultSymbolFromRow(typeof(PropertySymbol), row, columnZeroIsId: true); - case "PublishComponent": - return DefaultSymbolFromRow(typeof(PublishComponentSymbol), row, columnZeroIsId: false); - case "Registry": - { - var value = FieldAsString(row, 4); - var valueType = RegistryValueType.String; - var valueAction = RegistryValueActionType.Write; - - if (!String.IsNullOrEmpty(value)) - { - if (value.StartsWith("#x", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Binary; - value = value.Substring(2); - } - else if (value.StartsWith("#%", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Expandable; - value = value.Substring(2); - } - else if (value.StartsWith("#", StringComparison.Ordinal)) - { - valueType = RegistryValueType.Integer; - value = value.Substring(1); - } - else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3, value.Length - 6); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Write; - } - else if (value.StartsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Append; - } - else if (value.EndsWith("[~]", StringComparison.Ordinal)) - { - value = value.Substring(0, value.Length - 3); - valueType = RegistryValueType.MultiString; - valueAction = RegistryValueActionType.Prepend; - } - } - - return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Value = value, - ComponentRef = FieldAsString(row, 5), - ValueAction = valueAction, - ValueType = valueType, - }; - } - case "RegLocator": - { - var type = FieldAsInt(row, 4); - - return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - Type = (RegLocatorType)(type & 0xF), - Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit - }; - } - case "RemoveFile": - { - var splitName = FieldAsString(row, 2).Split('|'); - var installMode = FieldAsInt(row, 4); - - return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - ComponentRef = FieldAsString(row, 1), - FileName = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortFileName = splitName.Length > 1 ? splitName[0] : null, - DirPropertyRef = FieldAsString(row, 3), - OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, - OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null - }; - } - case "RemoveRegistry": - { - return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - Action = RemoveRegistryActionType.RemoveOnInstall, - Root = (RegistryRootType)FieldAsInt(row, 1), - Key = FieldAsString(row, 2), - Name = FieldAsString(row, 3), - ComponentRef = FieldAsString(row, 4), - }; - } - - case "ReserveCost": - return DefaultSymbolFromRow(typeof(ReserveCostSymbol), row, columnZeroIsId: true); - case "SelfReg": - return null; - case "ServiceControl": - { - var events = FieldAsInt(row, 2); - var wait = FieldAsNullableInt(row, 4); - return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - Name = FieldAsString(row, 1), - Arguments = FieldAsString(row, 3), - Wait = !wait.HasValue || wait.Value == 1, - ComponentRef = FieldAsString(row, 5), - InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, - UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, - InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, - UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, - InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, - UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, - }; - } - - case "ServiceInstall": - return DefaultSymbolFromRow(typeof(ServiceInstallSymbol), row, columnZeroIsId: true); - case "Shortcut": - { - var splitName = FieldAsString(row, 2).Split('|'); - - return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - DirectoryRef = FieldAsString(row, 1), - Name = splitName.Length > 1 ? splitName[1] : splitName[0], - ShortName = splitName.Length > 1 ? splitName[0] : null, - ComponentRef = FieldAsString(row, 3), - Target = FieldAsString(row, 4), - Arguments = FieldAsString(row, 5), - Description = FieldAsString(row, 6), - Hotkey = FieldAsNullableInt(row, 7), - IconRef = FieldAsString(row, 8), - IconIndex = FieldAsNullableInt(row, 9), - Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), - WorkingDirectory = FieldAsString(row, 11), - DisplayResourceDll = FieldAsString(row, 12), - DisplayResourceId = FieldAsNullableInt(row, 13), - DescriptionResourceDll = FieldAsString(row, 14), - DescriptionResourceId= FieldAsNullableInt(row, 15), - }; - } - case "Signature": - return DefaultSymbolFromRow(typeof(SignatureSymbol), row, columnZeroIsId: true); - case "UIText": - return DefaultSymbolFromRow(typeof(UITextSymbol), row, columnZeroIsId: true); - case "Upgrade": - { - var attributes = FieldAsInt(row, 4); - return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) - { - UpgradeCode = FieldAsString(row, 0), - VersionMin = FieldAsString(row, 1), - VersionMax = FieldAsString(row, 2), - Language = FieldAsString(row, 3), - Remove = FieldAsString(row, 5), - ActionProperty = FieldAsString(row, 6), - MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, - OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, - IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, - VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, - VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, - ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, - }; - } - case "Verb": - return DefaultSymbolFromRow(typeof(VerbSymbol), row, columnZeroIsId: false); - case "WixAction": - { - var sequenceTable = FieldAsString(row, 0); - return new WixActionSymbol(SourceLineNumber4(row.SourceLineNumbers)) - { - SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), - Action = FieldAsString(row, 1), - Condition = FieldAsString(row, 2), - Sequence = FieldAsNullableInt(row, 3), - Before = FieldAsString(row, 4), - After = FieldAsString(row, 5), - Overridable = FieldAsNullableInt(row, 6) != 0, - }; - } - case "WixBootstrapperApplication": - return DefaultSymbolFromRow(typeof(WixBootstrapperApplicationSymbol), row, columnZeroIsId: true); - case "WixBundleContainer": - return DefaultSymbolFromRow(typeof(WixBundleContainerSymbol), row, columnZeroIsId: true); - case "WixBundleVariable": - return DefaultSymbolFromRow(typeof(WixBundleVariableSymbol), row, columnZeroIsId: true); - case "WixChainItem": - return DefaultSymbolFromRow(typeof(WixChainItemSymbol), row, columnZeroIsId: true); - case "WixCustomTable": - return DefaultSymbolFromRow(typeof(WixCustomTableSymbol), row, columnZeroIsId: true); - case "WixDirectory": - return null; - case "WixFile": - return null; - case "WixInstanceTransforms": - return DefaultSymbolFromRow(typeof(WixInstanceTransformsSymbol), row, columnZeroIsId: true); - case "WixMedia": - return null; - case "WixMerge": - return DefaultSymbolFromRow(typeof(WixMergeSymbol), row, columnZeroIsId: true); - case "WixPatchBaseline": - return DefaultSymbolFromRow(typeof(WixPatchBaselineSymbol), row, columnZeroIsId: true); - case "WixProperty": - { - var attributes = FieldAsInt(row, 1); - return new WixPropertySymbol(SourceLineNumber4(row.SourceLineNumbers)) - { - PropertyRef = FieldAsString(row, 0), - Admin = (attributes & 0x1) == 0x1, - Hidden = (attributes & 0x2) == 0x2, - Secure = (attributes & 0x4) == 0x4, - }; - } - case "WixSuppressModularization": - { - return new WixSuppressModularizationSymbol(SourceLineNumber4(row.SourceLineNumbers)) - { - SuppressIdentifier = FieldAsString(row, 0) - }; - } - case "WixUI": - return DefaultSymbolFromRow(typeof(WixUISymbol), row, columnZeroIsId: true); - case "WixVariable": - return DefaultSymbolFromRow(typeof(WixVariableSymbol), row, columnZeroIsId: true); - default: - return GenericSymbolFromCustomRow(row, columnZeroIsId: false); - } - } - - private static CustomActionTargetType DetermineCustomActionTargetType(int type) - { - var targetType = default(CustomActionTargetType); - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) - { - targetType = CustomActionTargetType.VBScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) - { - targetType = CustomActionTargetType.JScript; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) - { - targetType = CustomActionTargetType.TextData; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) - { - targetType = CustomActionTargetType.Exe; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) - { - targetType = CustomActionTargetType.Dll; - } - - return targetType; - } - - private static CustomActionSourceType DetermineCustomActionSourceType(int type) - { - var sourceType = CustomActionSourceType.Binary; - - if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) - { - sourceType = CustomActionSourceType.Property; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) - { - sourceType = CustomActionSourceType.Directory; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) - { - sourceType = CustomActionSourceType.File; - } - - return sourceType; - } - - private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) - { - var executionType = CustomActionExecutionType.Immediate; - - if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) - { - executionType = CustomActionExecutionType.Commit; - } - else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) - { - executionType = CustomActionExecutionType.Rollback; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) - { - executionType = CustomActionExecutionType.Deferred; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) - { - executionType = CustomActionExecutionType.ClientRepeat; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) - { - executionType = CustomActionExecutionType.OncePerProcess; - } - else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) - { - executionType = CustomActionExecutionType.FirstSequence; - } - - return executionType; - } - - private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) - { - switch (columnType) - { - case Wix3.ColumnType.Number: - return IntermediateFieldType.Number; - case Wix3.ColumnType.Object: - return IntermediateFieldType.Path; - case Wix3.ColumnType.Unknown: - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Preserved: - default: - return IntermediateFieldType.String; - } - } - - private static IntermediateSymbol DefaultSymbolFromRow(Type symbolType, Wix3.Row row, bool columnZeroIsId) - { - var id = columnZeroIsId ? GetIdentifierForRow(row) : null; - - var createSymbol = symbolType.GetConstructor(new[] { typeof(SourceLineNumber), typeof(Identifier) }); - var symbol = (IntermediateSymbol)createSymbol.Invoke(new object[] { SourceLineNumber4(row.SourceLineNumbers), id }); - - SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); - - return symbol; - } - - private static IntermediateSymbol GenericSymbolFromCustomRow(Wix3.Row row, bool columnZeroIsId) - { - var columnDefinitions = row.Table.Definition.Columns.Cast(); - var fieldDefinitions = columnDefinitions.Select(columnDefinition => - new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); - var symbolDefinition = new IntermediateSymbolDefinition(row.Table.Name, fieldDefinitions, null); - - var id = columnZeroIsId ? GetIdentifierForRow(row) : null; - - var createSymbol = typeof(IntermediateSymbol).GetConstructor(new[] { typeof(IntermediateSymbolDefinition), typeof(SourceLineNumber), typeof(Identifier) }); - var symbol = (IntermediateSymbol)createSymbol.Invoke(new object[] { symbolDefinition, SourceLineNumber4(row.SourceLineNumbers), id }); - - SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); - - return symbol; - } - - private static void SetSymbolFieldsFromRow(Wix3.Row row, IntermediateSymbol symbol, bool columnZeroIsId) - { - var offset = 0; - if (columnZeroIsId) - { - offset = 1; - } - - for (var i = offset; i < row.Fields.Length; ++i) - { - var column = row.Fields[i].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - symbol.Set(i - offset, FieldAsString(row, i)); - break; - case Wix3.ColumnType.Number: - int? nullableValue = FieldAsNullableInt(row, i); - // TODO: Consider whether null values should be coerced to their default value when - // a column is not nullable. For now, just pass through the null. - //int value = FieldAsInt(row, i); - //symbol.Set(i - offset, column.IsNullable ? nullableValue : value); - symbol.Set(i - offset, nullableValue); - break; - case Wix3.ColumnType.Unknown: - break; - } - } - } - - private static Identifier GetIdentifierForRow(Wix3.Row row) - { - var column = row.Fields[0].Column; - switch (column.Type) - { - case Wix3.ColumnType.String: - case Wix3.ColumnType.Localized: - case Wix3.ColumnType.Object: - case Wix3.ColumnType.Preserved: - return new Identifier(AccessModifier.Global, (string)row.Fields[0].Data); - case Wix3.ColumnType.Number: - return new Identifier(AccessModifier.Global, FieldAsInt(row, 0)); - default: - return null; - } - } - - private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) - { - switch (outputType) - { - case Wix3.OutputType.Bundle: - return SectionType.Bundle; - case Wix3.OutputType.Module: - return SectionType.Module; - case Wix3.OutputType.Patch: - return SectionType.Patch; - case Wix3.OutputType.PatchCreation: - return SectionType.PatchCreation; - case Wix3.OutputType.Product: - return SectionType.Product; - case Wix3.OutputType.Transform: - case Wix3.OutputType.Unknown: - default: - return SectionType.Unknown; - } - } - - private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) - { - return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); - } - - private static string FieldAsString(Wix3.Row row, int column) - { - return (string)row[column]; - } - - private static int FieldAsInt(Wix3.Row row, int column) - { - return Convert.ToInt32(row[column]); - } - - private static int? FieldAsNullableInt(Wix3.Row row, int column) - { - var field = row.Fields[column]; - if (field.Data == null) - { - return null; - } - else - { - return Convert.ToInt32(field.Data); - } - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : null, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : null - }; - } - } -} diff --git a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj deleted file mode 100644 index 445c3500..00000000 --- a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - netstandard2.0 - $(TargetFrameworks);net461;net472 - Symbolizer - WiX Toolset Converters Tuplizer - embedded - true - true - - - - - - - - - - - - - - - - - - - diff --git a/src/WixToolset.Converters/ConvertCommand.cs b/src/WixToolset.Converters/ConvertCommand.cs deleted file mode 100644 index b6826f43..00000000 --- a/src/WixToolset.Converters/ConvertCommand.cs +++ /dev/null @@ -1,60 +0,0 @@ -// 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.Converters -{ - using System; - using System.Threading; - using System.Threading.Tasks; - using WixToolset.Extensibility.Services; - - internal class ConvertCommand : FixupCommandBase - { - private const string SettingsFileDefault = "wix.convert.settings.xml"; - - public ConvertCommand(IServiceProvider serviceProvider) - { - this.Messaging = serviceProvider.GetService(); - } - - private IMessaging Messaging { get; } - - public override Task ExecuteAsync(CancellationToken cancellationToken) - { - if (this.ShowHelp) - { - DisplayHelp(); - return Task.FromResult(-1); - } - - this.ParseSettings(SettingsFileDefault); - - var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); - - var errors = base.Inspect(Inspector, cancellationToken); - - return Task.FromResult(errors); - - int Inspector(string file, bool fix) - { - return converter.ConvertFile(file, fix); - } - } - - private static void DisplayHelp() - { - Console.WriteLine(); - Console.WriteLine("Usage: wix convert [options] sourceFile [sourceFile ...]"); - Console.WriteLine(); - Console.WriteLine("Options:"); - Console.WriteLine(" -h|--help Show command line help."); - Console.WriteLine(" --nologo Suppress displaying the logo information."); - Console.WriteLine(" -n|--dry-run Only display errors, do not update files."); - Console.WriteLine(" -r|--recurse Search for matching files in current dir and subdirs."); - Console.WriteLine(" -set1 Primary settings file."); - Console.WriteLine(" -set2 Secondary settings file (overrides primary)."); - Console.WriteLine(" -indent: Indentation multiple (overrides default of 4)."); - Console.WriteLine(); - Console.WriteLine(" sourceFile may use wildcards like *.wxs"); - } - } -} diff --git a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs b/src/WixToolset.Converters/ConverterExtensionCommandLine.cs deleted file mode 100644 index 06d3658c..00000000 --- a/src/WixToolset.Converters/ConverterExtensionCommandLine.cs +++ /dev/null @@ -1,46 +0,0 @@ -// 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.Converters -{ - using System; - using System.Collections.Generic; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Data; - using WixToolset.Extensibility.Services; - - /// - /// Parses the "convert" command-line command. See ConvertCommand for - /// the bulk of the command-line processing. - /// - internal class ConverterExtensionCommandLine : BaseExtensionCommandLine - { - public ConverterExtensionCommandLine(IServiceProvider serviceProvider) - { - this.ServiceProvider = serviceProvider; - } - - private IServiceProvider ServiceProvider { get; } - - public override IReadOnlyCollection CommandLineSwitches => new ExtensionCommandLineSwitch[] - { - new ExtensionCommandLineSwitch { Switch = "convert", Description = "Convert v3 source code to v4 source code." }, - new ExtensionCommandLineSwitch { Switch = "format", Description = "Ensures consistent formatting of source code." }, - }; - - public override bool TryParseCommand(ICommandLineParser parser, string argument, out ICommandLineCommand command) - { - command = null; - - if ("convert".Equals(argument, StringComparison.OrdinalIgnoreCase)) - { - command = new ConvertCommand(this.ServiceProvider); - } - else if ("format".Equals(argument, StringComparison.OrdinalIgnoreCase)) - { - command = new FormatCommand(this.ServiceProvider); - } - - return command != null; - } - } -} diff --git a/src/WixToolset.Converters/ConverterExtensionFactory.cs b/src/WixToolset.Converters/ConverterExtensionFactory.cs deleted file mode 100644 index d4f480aa..00000000 --- a/src/WixToolset.Converters/ConverterExtensionFactory.cs +++ /dev/null @@ -1,30 +0,0 @@ -// 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.Converters -{ - using System; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Services; - - internal class ConverterExtensionFactory : IExtensionFactory - { - public ConverterExtensionFactory(IServiceProvider serviceProvider) - { - this.ServiceProvider = serviceProvider; - } - - private IServiceProvider ServiceProvider { get; } - - public bool TryCreateExtension(Type extensionType, out object extension) - { - extension = null; - - if (extensionType == typeof(IExtensionCommandLine)) - { - extension = new ConverterExtensionCommandLine(this.ServiceProvider); - } - - return extension != null; - } - } -} diff --git a/src/WixToolset.Converters/FixupCommandBase.cs b/src/WixToolset.Converters/FixupCommandBase.cs deleted file mode 100644 index 21282d07..00000000 --- a/src/WixToolset.Converters/FixupCommandBase.cs +++ /dev/null @@ -1,288 +0,0 @@ -// 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.Converters -{ - using System; - using System.Collections.Generic; - using System.IO; - using System.Threading; - using System.Threading.Tasks; - using System.Xml; - using WixToolset.Extensibility.Data; - using WixToolset.Extensibility.Services; - - internal abstract class FixupCommandBase : ICommandLineCommand - { - protected FixupCommandBase() - { - this.IndentationAmount = 4; // default indentation amount - this.ErrorsAsWarnings = new HashSet(); - this.ExemptFiles = new HashSet(); - this.IgnoreErrors = new HashSet(); - this.SearchPatternResults = new HashSet(); - this.SearchPatterns = new List(); - } - - public bool ShowLogo { get; private set; } - - public bool StopParsing { get; private set; } - - protected bool ShowHelp { get; set; } - - protected CustomTableTarget CustomTableSetting { get; set; } - - protected bool DryRun { get; set; } - - protected HashSet ErrorsAsWarnings { get; } - - protected HashSet IgnoreErrors { get; } - - protected HashSet ExemptFiles { get; } - - protected int IndentationAmount { get; set; } - - protected bool Recurse { get; set; } - - private HashSet SearchPatternResults { get; } - - private List SearchPatterns { get; } - - private string SettingsFile1 { get; set; } - - private string SettingsFile2 { get; set; } - - public bool TryParseArgument(ICommandLineParser parser, string argument) - { - if (!parser.IsSwitch(argument)) - { - this.SearchPatterns.Add(argument); - return true; - } - - var parameter = argument.Substring(1); - switch (parameter.ToLowerInvariant()) - { - case "?": - case "h": - case "-help": - this.ShowHelp = true; - this.ShowLogo = true; - this.StopParsing = true; - return true; - - case "-custom-table": - var customTableSetting = parser.GetNextArgumentOrError(argument); - switch (customTableSetting) - { - case "bundle": - this.CustomTableSetting = CustomTableTarget.Bundle; - break; - case "msi": - this.CustomTableSetting = CustomTableTarget.Msi; - break; - default: - parser.ReportErrorArgument(argument); - break; - } - return true; - - case "n": - case "-dry-run": - this.DryRun = true; - return true; - - case "nologo": - case "-nologo": - this.ShowLogo = false; - return true; - - case "s": - case "r": - case "-recurse": - case "-recursive": - this.Recurse = true; - return true; - - default: // other parameters - if (parameter.StartsWith("set1", StringComparison.Ordinal)) - { - this.SettingsFile1 = parameter.Substring(4); - return true; - } - else if (parameter.StartsWith("set2", StringComparison.Ordinal)) - { - this.SettingsFile2 = parameter.Substring(4); - return true; - } - else if (parameter.StartsWith("indent:", StringComparison.Ordinal)) - { - try - { - this.IndentationAmount = Convert.ToInt32(parameter.Substring(7)); - } - catch - { - parser.ReportErrorArgument(parameter); // $"Invalid numeric argument: {parameter}"; - } - return true; - } - - return false; - } - } - - public abstract Task ExecuteAsync(CancellationToken cancellationToken); - - protected void ParseSettings(string defaultSettingsFile) - { - // parse the settings if any were specified - if (null != this.SettingsFile1 || null != this.SettingsFile2) - { - this.ParseSettingsFiles(this.SettingsFile1, this.SettingsFile2); - } - else - { - if (File.Exists(defaultSettingsFile)) - { - this.ParseSettingsFiles(defaultSettingsFile, null); - } - } - } - - protected int Inspect(Func inspector, CancellationToken cancellationToken) - { - var errors = this.InspectSubDirectories(inspector, Path.GetFullPath("."), cancellationToken); - - foreach (var searchPattern in this.SearchPatterns) - { - if (!this.SearchPatternResults.Contains(searchPattern)) - { - Console.Error.WriteLine("Could not find file \"{0}\"", searchPattern); - errors++; - } - } - - return errors; - } - - /// - /// Inspect sub-directories. - /// - /// - /// The directory whose sub-directories will be inspected. - /// - /// The number of errors that were found. - private int InspectSubDirectories(Func inspector, string directory, CancellationToken cancellationToken) - { - var errors = 0; - - foreach (var searchPattern in this.SearchPatterns) - { - foreach (var sourceFilePath in GetFiles(directory, searchPattern)) - { - cancellationToken.ThrowIfCancellationRequested(); - - var file = new FileInfo(sourceFilePath); - - if (!this.ExemptFiles.Contains(file.Name.ToUpperInvariant())) - { - this.SearchPatternResults.Add(searchPattern); - errors += inspector(file.FullName, !this.DryRun); - } - } - } - - if (this.Recurse) - { - foreach (var childDirectoryPath in Directory.GetDirectories(directory)) - { - errors += this.InspectSubDirectories(inspector, childDirectoryPath, cancellationToken); - } - } - - return errors; - } - - /// - /// Parse the primary and secondary settings files. - /// - /// The primary settings file. - /// The secondary settings file. - private void ParseSettingsFiles(string localSettingsFile1, string localSettingsFile2) - { - if (null == localSettingsFile1 && null != localSettingsFile2) - { - throw new ArgumentException("Cannot specify a secondary settings file (set2) without a primary settings file (set1).", nameof(localSettingsFile2)); - } - - var settingsFile = localSettingsFile1; - while (null != settingsFile) - { - var doc = new XmlDocument(); - doc.Load(settingsFile); - - // get the types of tests that will have their errors displayed as warnings - var testsIgnoredElements = doc.SelectNodes("/Settings/IgnoreErrors/Test"); - foreach (XmlElement test in testsIgnoredElements) - { - var key = test.GetAttribute("Id"); - this.IgnoreErrors.Add(key); - } - - // get the types of tests that will have their errors displayed as warnings - var testsAsWarningsElements = doc.SelectNodes("/Settings/ErrorsAsWarnings/Test"); - foreach (XmlElement test in testsAsWarningsElements) - { - var key = test.GetAttribute("Id"); - this.ErrorsAsWarnings.Add(key); - } - - // get the exempt files - var localExemptFiles = doc.SelectNodes("/Settings/ExemptFiles/File"); - foreach (XmlElement file in localExemptFiles) - { - var key = file.GetAttribute("Name").ToUpperInvariant(); - this.ExemptFiles.Add(key); - } - - settingsFile = localSettingsFile2; - localSettingsFile2 = null; - } - } - - /// - /// Get the files that match a search path pattern. - /// - /// The base directory at which to begin the search. - /// The search path pattern. - /// The files matching the pattern. - private static string[] GetFiles(string baseDir, string searchPath) - { - // convert alternate directory separators to the standard one - var filePath = searchPath.Replace(Path.AltDirectorySeparatorChar, Path.DirectorySeparatorChar); - var lastSeparator = filePath.LastIndexOf(Path.DirectorySeparatorChar); - string[] files = null; - - try - { - if (0 > lastSeparator) - { - files = Directory.GetFiles(baseDir, filePath); - } - else // found directory separator - { - var searchPattern = filePath.Substring(lastSeparator + 1); - - files = Directory.GetFiles(filePath.Substring(0, lastSeparator + 1), searchPattern); - } - } - catch (DirectoryNotFoundException) - { - // don't let this function throw the DirectoryNotFoundException. (this exception - // occurs for non-existant directories and invalid characters in the searchPattern) - } - - return files; - } - } -} diff --git a/src/WixToolset.Converters/FormatCommand.cs b/src/WixToolset.Converters/FormatCommand.cs deleted file mode 100644 index 0861fc51..00000000 --- a/src/WixToolset.Converters/FormatCommand.cs +++ /dev/null @@ -1,60 +0,0 @@ -// 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.Converters -{ - using System; - using System.Threading; - using System.Threading.Tasks; - using WixToolset.Extensibility.Services; - - internal class FormatCommand : FixupCommandBase - { - private const string SettingsFileDefault = "wix.format.settings.xml"; - - public FormatCommand(IServiceProvider serviceProvider) - { - this.Messaging = serviceProvider.GetService(); - } - - private IMessaging Messaging { get; } - - public override Task ExecuteAsync(CancellationToken cancellationToken) - { - if (this.ShowHelp) - { - DisplayHelp(); - return Task.FromResult(-1); - } - - var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); - - this.ParseSettings(SettingsFileDefault); - - var errors = base.Inspect(Inspector, cancellationToken); - - return Task.FromResult(errors); - - int Inspector(string file, bool fix) - { - return converter.FormatFile(file, fix); - } - } - - private static void DisplayHelp() - { - Console.WriteLine(); - Console.WriteLine("Usage: wix format [options] sourceFile [sourceFile ...]"); - Console.WriteLine(); - Console.WriteLine("Options:"); - Console.WriteLine(" -h|--help Show command line help."); - Console.WriteLine(" --nologo Suppress displaying the logo information."); - Console.WriteLine(" -n|--dry-run Only display errors, do not update files."); - Console.WriteLine(" -r|--recurse Search for matching files in current dir and subdirs."); - Console.WriteLine(" -set1 Primary settings file."); - Console.WriteLine(" -set2 Secondary settings file (overrides primary)."); - Console.WriteLine(" -indent: Indentation multiple (overrides default of 4)."); - Console.WriteLine(); - Console.WriteLine(" sourceFile may use wildcards like *.wxs"); - } - } -} diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs deleted file mode 100644 index e42d0605..00000000 --- a/src/WixToolset.Converters/WixConverter.cs +++ /dev/null @@ -1,2435 +0,0 @@ -// 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.Converters -{ - using System; - using System.Collections.Generic; - using System.Globalization; - using System.IO; - using System.Linq; - using System.Text; - using System.Text.RegularExpressions; - using System.Xml; - using System.Xml.Linq; - using WixToolset.Data; - using WixToolset.Data.WindowsInstaller; - using WixToolset.Extensibility.Services; - - /// - /// How to convert CustomTable elements. - /// - public enum CustomTableTarget - { - /// - /// Ambiguous elements will be left alone. - /// - Unknown, - - /// - /// Use CustomTable, CustomTableRef, and Unreal. - /// - Msi, - - /// - /// Use BundleCustomData and BundleCustomDataRef. - /// - Bundle, - } - - /// - /// WiX source code converter. - /// - public sealed class WixConverter - { - private enum ConvertOperation - { - Convert, - Format, - } - - private static readonly Regex AddPrefix = new Regex(@"^[^a-zA-Z_]", RegexOptions.Compiled); - private static readonly Regex IllegalIdentifierCharacters = new Regex(@"[^A-Za-z0-9_\.]|\.{2,}", RegexOptions.Compiled); // non 'words' and assorted valid characters - - private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". - private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; - private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; - private static readonly XNamespace WixBalNamespace = "http://wixtoolset.org/schemas/v4/wxs/bal"; - private static readonly XNamespace WixDependencyNamespace = "http://wixtoolset.org/schemas/v4/wxs/dependency"; - private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; - private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall"; - - private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; - private static readonly XName AdminUISequenceSequenceElementName = WixNamespace + "AdminUISequence"; - private static readonly XName AdvertiseExecuteSequenceElementName = WixNamespace + "AdvertiseExecuteSequence"; - private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; - private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; - private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication"; - private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; - private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef"; - private static readonly XName ApprovedExeForElevationElementName = WixNamespace + "ApprovedExeForElevation"; - private static readonly XName BundleAttributeElementName = WixNamespace + "BundleAttribute"; - private static readonly XName BundleAttributeDefinitionElementName = WixNamespace + "BundleAttributeDefinition"; - private static readonly XName BundleCustomDataElementName = WixNamespace + "BundleCustomData"; - private static readonly XName BundleCustomDataRefElementName = WixNamespace + "BundleCustomDataRef"; - private static readonly XName BundleElementElementName = WixNamespace + "BundleElement"; - private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; - private static readonly XName CustomTableRefElementName = WixNamespace + "CustomTableRef"; - private static readonly XName CatalogElementName = WixNamespace + "Catalog"; - private static readonly XName ColumnElementName = WixNamespace + "Column"; - private static readonly XName ComponentElementName = WixNamespace + "Component"; - private static readonly XName ControlElementName = WixNamespace + "Control"; - private static readonly XName ConditionElementName = WixNamespace + "Condition"; - private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; - private static readonly XName DataElementName = WixNamespace + "Data"; - private static readonly XName OldProvidesElementName = WixDependencyNamespace + "Provides"; - private static readonly XName OldRequiresElementName = WixDependencyNamespace + "Requires"; - private static readonly XName OldRequiresRefElementName = WixDependencyNamespace + "RequiresRef"; - private static readonly XName DirectoryElementName = WixNamespace + "Directory"; - private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; - private static readonly XName ErrorElementName = WixNamespace + "Error"; - private static readonly XName FeatureElementName = WixNamespace + "Feature"; - private static readonly XName FileElementName = WixNamespace + "File"; - private static readonly XName FragmentElementName = WixNamespace + "Fragment"; - private static readonly XName FirewallRemoteAddressElementName = WixFirewallNamespace + "RemoteAddress"; - private static readonly XName LaunchElementName = WixNamespace + "Launch"; - private static readonly XName LevelElementName = WixNamespace + "Level"; - private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; - private static readonly XName ExePackagePayloadElementName = WixNamespace + "ExePackagePayload"; - private static readonly XName ModuleElementName = WixNamespace + "Module"; - private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; - private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; - private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; - private static readonly XName MsuPackagePayloadElementName = WixNamespace + "MsuPackagePayload"; - private static readonly XName PackageElementName = WixNamespace + "Package"; - private static readonly XName PayloadElementName = WixNamespace + "Payload"; - private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; - private static readonly XName ProductElementName = WixNamespace + "Product"; - private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; - private static readonly XName PropertyRefElementName = WixNamespace + "PropertyRef"; - private static readonly XName PublishElementName = WixNamespace + "Publish"; - private static readonly XName ProvidesElementName = WixNamespace + "Provides"; - private static readonly XName RequiresElementName = WixNamespace + "Requires"; - private static readonly XName RequiresRefElementName = WixNamespace + "RequiresRef"; - private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; - private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; - private static readonly XName RegistryKeyElementName = WixNamespace + "RegistryKey"; - private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; - private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; - private static readonly XName RowElementName = WixNamespace + "Row"; - private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; - private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; - private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; - private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; - private static readonly XName SoftwareTagElementName = WixNamespace + "SoftwareTag"; - private static readonly XName SoftwareTagRefElementName = WixNamespace + "SoftwareTagRef"; - private static readonly XName StandardDirectoryElementName = WixNamespace + "StandardDirectory"; - private static readonly XName TagElementName = XNamespace.None + "Tag"; - private static readonly XName TagRefElementName = XNamespace.None + "TagRef"; - private static readonly XName TextElementName = WixNamespace + "Text"; - private static readonly XName UITextElementName = WixNamespace + "UIText"; - private static readonly XName VariableElementName = WixNamespace + "Variable"; - private static readonly XName VerbElementName = WixNamespace + "Verb"; - private static readonly XName BalUseUILanguagesName = WixBalNamespace + "UseUILanguages"; - private static readonly XName BalStandardBootstrapperApplicationName = WixBalNamespace + "WixStandardBootstrapperApplication"; - private static readonly XName BalManagedBootstrapperApplicationHostName = WixBalNamespace + "WixManagedBootstrapperApplicationHost"; - private static readonly XName BalOldDotNetCoreBootstrapperApplicationName = WixBalNamespace + "WixDotNetCoreBootstrapperApplication"; - private static readonly XName BalNewDotNetCoreBootstrapperApplicationName = WixBalNamespace + "WixDotNetCoreBootstrapperApplicationHost"; - private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; - private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; - private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; - private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; - private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; - private static readonly XName CustomActionRefElementName = WixNamespace + "CustomActionRef"; - private static readonly XName PropertyElementName = WixNamespace + "Property"; - private static readonly XName Wix4ElementName = WixNamespace + "Wix"; - private static readonly XName Wix3ElementName = Wix3Namespace + "Wix"; - private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; - private static readonly XName Include4ElementName = WixNamespace + "Include"; - private static readonly XName Include3ElementName = Wix3Namespace + "Include"; - private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; - private static readonly XName SummaryInformationElementName = WixNamespace + "SummaryInformation"; - private static readonly XName MediaTemplateElementName = WixNamespace + "MediaTemplate"; - - private static readonly XName DependencyCheckAttributeName = WixDependencyNamespace + "Check"; - private static readonly XName DependencyEnforceAttributeName = WixDependencyNamespace + "Enforce"; - - private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() - { - { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, - { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, - { "http://schemas.microsoft.com/wix/DependencyExtension", WixDependencyNamespace }, - { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, - { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, - { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, - { "http://schemas.microsoft.com/wix/IIsExtension", "http://wixtoolset.org/schemas/v4/wxs/iis" }, - { "http://schemas.microsoft.com/wix/MsmqExtension", "http://wixtoolset.org/schemas/v4/wxs/msmq" }, - { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, - { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, - { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, - { "http://schemas.microsoft.com/wix/TagExtension", XNamespace.None }, - { "http://schemas.microsoft.com/wix/UtilExtension", WixUtilNamespace }, - { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, - { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, - { "http://schemas.microsoft.com/wix/2009/Lux", "http://wixtoolset.org/schemas/v4/lux" }, - { "http://schemas.microsoft.com/wix/2006/wi", "http://wixtoolset.org/schemas/v4/wxs" }, - { "http://schemas.microsoft.com/wix/2006/localization", "http://wixtoolset.org/schemas/v4/wxl" }, - { "http://schemas.microsoft.com/wix/2006/libraries", "http://wixtoolset.org/schemas/v4/wixlib" }, - { "http://schemas.microsoft.com/wix/2006/objects", "http://wixtoolset.org/schemas/v4/wixobj" }, - { "http://schemas.microsoft.com/wix/2006/outputs", "http://wixtoolset.org/schemas/v4/wixout" }, - { "http://schemas.microsoft.com/wix/2007/pdbs", "http://wixtoolset.org/schemas/v4/wixpdb" }, - { "http://schemas.microsoft.com/wix/2003/04/actions", "http://wixtoolset.org/schemas/v4/wi/actions" }, - { "http://schemas.microsoft.com/wix/2006/tables", "http://wixtoolset.org/schemas/v4/wi/tables" }, - { "http://schemas.microsoft.com/wix/2006/WixUnit", "http://wixtoolset.org/schemas/v4/wixunit" }, - }; - - private readonly Dictionary> ConvertElementMapping; - private readonly Regex DeprecatedPrefixRegex = new Regex(@"(?<=(^|[^\$])(\$\$)*)\$(?=\(loc\.[^.].*\))", - RegexOptions.Compiled | RegexOptions.CultureInvariant | RegexOptions.ExplicitCapture); - - /// - /// Instantiate a new Converter class. - /// - /// - /// Indentation value to use when validating leading whitespace. - /// Test errors to display as warnings. - /// Test errors to ignore. - /// How to convert CustomTable elements. - public WixConverter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null, CustomTableTarget customTableTarget = CustomTableTarget.Unknown) - { - this.ConvertElementMapping = new Dictionary> - { - { WixConverter.AdminExecuteSequenceElementName, this.ConvertSequenceElement }, - { WixConverter.AdminUISequenceSequenceElementName, this.ConvertSequenceElement }, - { WixConverter.AdvertiseExecuteSequenceElementName, this.ConvertSequenceElement }, - { WixConverter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, - { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, - { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement }, - { WixConverter.BootstrapperApplicationRefElementName, this.ConvertBootstrapperApplicationRefElement }, - { WixConverter.ApprovedExeForElevationElementName, this.ConvertApprovedExeForElevationElement }, - { WixConverter.CatalogElementName, this.ConvertCatalogElement }, - { WixConverter.ColumnElementName, this.ConvertColumnElement }, - { WixConverter.ComponentElementName, this.ConvertComponentElement }, - { WixConverter.ControlElementName, this.ConvertControlElement }, - { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, - { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, - { WixConverter.DataElementName, this.ConvertDataElement }, - { WixConverter.DirectoryElementName, this.ConvertDirectoryElement }, - { WixConverter.FeatureElementName, this.ConvertFeatureElement }, - { WixConverter.FileElementName, this.ConvertFileElement }, - { WixConverter.FragmentElementName, this.ConvertFragmentElement }, - { WixConverter.FirewallRemoteAddressElementName, this.ConvertFirewallRemoteAddressElement }, - { WixConverter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, - { WixConverter.ErrorElementName, this.ConvertErrorElement }, - { WixConverter.ExePackageElementName, this.ConvertExePackageElement }, - { WixConverter.ModuleElementName, this.ConvertModuleElement }, - { WixConverter.MsiPackageElementName, this.ConvertWindowsInstallerPackageElement }, - { WixConverter.MspPackageElementName, this.ConvertWindowsInstallerPackageElement }, - { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, - { WixConverter.OldProvidesElementName, this.ConvertProvidesElement }, - { WixConverter.OldRequiresElementName, this.ConvertRequiresElement }, - { WixConverter.OldRequiresRefElementName, this.ConvertRequiresRefElement }, - { WixConverter.PayloadElementName, this.ConvertSuppressSignatureValidation }, - { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, - { WixConverter.ProductElementName, this.ConvertProductElement }, - { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, - { WixConverter.PropertyRefElementName, this.ConvertPropertyRefElement }, - { WixConverter.PublishElementName, this.ConvertPublishElement }, - { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, - { WixConverter.RegistryKeyElementName, this.ConvertRegistryKeyElement }, - { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement }, - { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, - { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, - { WixConverter.CustomActionRefElementName, this.ConvertCustomActionRefElement }, - { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, - { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, - { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, - { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, - { WixConverter.TagElementName, this.ConvertTagElement }, - { WixConverter.TagRefElementName, this.ConvertTagRefElement }, - { WixConverter.TextElementName, this.ConvertTextElement }, - { WixConverter.UITextElementName, this.ConvertUITextElement }, - { WixConverter.VariableElementName, this.ConvertVariableElement }, - { WixConverter.UtilCloseApplicationElementName, this.ConvertUtilCloseApplicationElementName }, - { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, - { WixConverter.UtilRegistrySearchName, this.ConvertUtilRegistrySearchElement }, - { WixConverter.UtilXmlConfigElementName, this.ConvertUtilXmlConfigElement }, - { WixConverter.PropertyElementName, this.ConvertPropertyElement }, - { WixConverter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, - { WixConverter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, - { WixConverter.VerbElementName, this.ConvertVerbElement }, - }; - - this.Messaging = messaging; - - this.IndentationAmount = indentationAmount; - - this.ErrorsAsWarnings = new HashSet(this.YieldConverterTypes(errorsAsWarnings)); - - this.IgnoreErrors = new HashSet(this.YieldConverterTypes(ignoreErrors)); - - this.CustomTableSetting = customTableTarget; - } - - private CustomTableTarget CustomTableSetting { get; } - - private int Errors { get; set; } - - private HashSet ErrorsAsWarnings { get; set; } - - private HashSet IgnoreErrors { get; set; } - - private IMessaging Messaging { get; } - - private int IndentationAmount { get; set; } - - private ConvertOperation Operation { get; set; } - - private string SourceFile { get; set; } - - private int SourceVersion { get; set; } - - /// - /// Convert a file. - /// - /// The file to convert. - /// Option to save the converted errors that are found. - /// The number of errors found. - public int ConvertFile(string sourceFile, bool saveConvertedFile) - { - var document = this.OpenSourceFile(sourceFile); - - if (document is null) - { - return 1; - } - - this.ConvertDocument(document); - - // Fix errors if requested and necessary. - if (saveConvertedFile && 0 < this.Errors) - { - this.SaveDocument(document); - } - - return this.Errors; - } - - /// - /// Convert a document. - /// - /// The document to convert. - /// The number of errors found. - public int ConvertDocument(XDocument document) - { - // Reset the instance info. - this.Errors = 0; - this.SourceVersion = 0; - this.Operation = ConvertOperation.Convert; - - // Remove the declaration. - if (null != document.Declaration - && this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) - { - document.Declaration = null; - TrimLeadingText(document); - } - - // Start converting the nodes at the top. - this.ConvertNodes(document.Nodes(), 0); - this.RemoveUnusedNamespaces(document.Root); - - return this.Errors; - } - - /// - /// Format a file. - /// - /// The file to format. - /// Option to save the format errors that are found. - /// The number of errors found. - public int FormatFile(string sourceFile, bool saveConvertedFile) - { - var document = this.OpenSourceFile(sourceFile); - - if (document is null) - { - return 1; - } - - this.FormatDocument(document); - - // Fix errors if requested and necessary. - if (saveConvertedFile && 0 < this.Errors) - { - this.SaveDocument(document); - } - - return this.Errors; - } - - /// - /// Format a document. - /// - /// The document to format. - /// The number of errors found. - public int FormatDocument(XDocument document) - { - // Reset the instance info. - this.Errors = 0; - this.SourceVersion = 0; - this.Operation = ConvertOperation.Format; - - // Remove the declaration. - if (null != document.Declaration - && this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) - { - document.Declaration = null; - TrimLeadingText(document); - } - - // Start converting the nodes at the top. - this.ConvertNodes(document.Nodes(), 0); - this.RemoveUnusedNamespaces(document.Root); - - return this.Errors; - } - - private XDocument OpenSourceFile(string sourceFile) - { - this.SourceFile = sourceFile; - - try - { - return XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - } - catch (XmlException e) - { - this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); - } - - return null; - } - - private void SaveDocument(XDocument document) - { - var ignoreDeclarationError = this.IgnoreErrors.Contains(ConverterTestType.DeclarationPresent); - - try - { - using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = !ignoreDeclarationError })) - { - document.Save(writer); - } - } - catch (UnauthorizedAccessException) - { - this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); - } - } - - private void ConvertNodes(IEnumerable nodes, int level) - { - // Note we operate on a copy of the node list since we may - // remove some whitespace nodes during this processing. - foreach (var node in nodes.ToList()) - { - if (node is XText text) - { - if (null != text.Value) - { - if (this.TryFixDeprecatedLocalizationPrefixes(node, text.Value, out var newValue, ConverterTestType.DeprecatedLocalizationVariablePrefixInTextValue)) - { - text.Value = newValue; - } - } - if (!String.IsNullOrWhiteSpace(text.Value)) - { - text.Value = text.Value.Trim(); - } - else if (node.NextNode is XCData cdata) - { - this.EnsurePrecedingWhitespaceRemoved(text, node, ConverterTestType.WhitespacePrecedingNodeWrong); - } - else if (node.NextNode is XElement element) - { - this.EnsurePrecedingWhitespaceCorrect(text, node, level, ConverterTestType.WhitespacePrecedingNodeWrong); - } - else if (node.NextNode is null) // this is the space before the close element - { - if (node.PreviousNode is null || node.PreviousNode is XCData) - { - this.EnsurePrecedingWhitespaceRemoved(text, node.Parent, ConverterTestType.WhitespacePrecedingEndElementWrong); - } - else if (level == 0) // root element's close tag - { - this.EnsurePrecedingWhitespaceCorrect(text, node, 0, ConverterTestType.WhitespacePrecedingEndElementWrong); - } - else - { - this.EnsurePrecedingWhitespaceCorrect(text, node, level - 1, ConverterTestType.WhitespacePrecedingEndElementWrong); - } - } - } - else if (node is XElement element) - { - this.ConvertElement(element); - - var before = element.Nodes().ToList(); - - this.ConvertNodes(before, level + 1); - - // If any nodes were added during the processing of the children, - // ensure those added children get processed as well. - var added = element.Nodes().Except(before).ToList(); - - if (added.Any()) - { - this.ConvertNodes(added, level + 1); - } - } - } - } - - private bool TryFixDeprecatedLocalizationPrefixes(XNode node, string value, out string newValue, ConverterTestType testType) - { - newValue = this.DeprecatedPrefixRegex.Replace(value, "!"); - - if (object.ReferenceEquals(newValue, value)) - { - return false; - } - - var message = testType == ConverterTestType.DeprecatedLocalizationVariablePrefixInTextValue ? "The prefix on the localization variable in the inner text is incorrect." : "The prefix on the localization variable in the attribute value is incorrect."; - - return this.OnError(testType, node, message); - } - - private void EnsurePrecedingWhitespaceCorrect(XText whitespace, XNode node, int level, ConverterTestType testType) - { - if (!WixConverter.LeadingWhitespaceValid(this.IndentationAmount, level, whitespace.Value)) - { - var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; - - if (this.OnError(testType, node, message)) - { - WixConverter.FixupWhitespace(this.IndentationAmount, level, whitespace); - } - } - } - - private void EnsurePrecedingWhitespaceRemoved(XText whitespace, XNode node, ConverterTestType testType) - { - if (!String.IsNullOrEmpty(whitespace.Value) && whitespace.NodeType != XmlNodeType.CDATA) - { - var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; - - if (this.OnError(testType, node, message)) - { - whitespace.Remove(); - } - } - } - - private void ConvertElement(XElement element) - { - var deprecatedToUpdatedNamespaces = new Dictionary(); - - foreach (var attribute in element.Attributes()) - { - if (attribute.IsNamespaceDeclaration) - { - // Gather any deprecated namespaces, then update this element tree based on those deprecations. - var declaration = attribute; - - if (element.Name == Wix3ElementName || element.Name == Include3ElementName) - { - this.SourceVersion = 3; - } - else if (element.Name == Wix4ElementName || element.Name == Include4ElementName) - { - this.SourceVersion = 4; - } - - if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) - { - if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) - { - deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); - } - } - } - else - { - if (null != attribute.Value) - { - if (this.TryFixDeprecatedLocalizationPrefixes(element, attribute.Value, out var newValue, ConverterTestType.DeprecatedLocalizationVariablePrefixInAttributeValue)) - { - attribute.Value = newValue; - } - } - } - } - - if (deprecatedToUpdatedNamespaces.Any()) - { - WixConverter.UpdateElementsWithDeprecatedNamespaces(element.DescendantsAndSelf(), deprecatedToUpdatedNamespaces); - } - - // Apply any specialized conversion actions. - if (this.ConvertElementMapping.TryGetValue(element.Name, out var convert)) - { - convert(element); - } - } - - private void ConvertBootstrapperApplicationElement(XElement element) - { - var xUseUILanguages = element.Attribute(BalUseUILanguagesName); - if (xUseUILanguages != null && - this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior.")) - { - xUseUILanguages.Remove(); - } - - var xBADll = element.Elements(BootstrapperApplicationDllElementName).FirstOrDefault(); - if (xBADll == null) - { - xBADll = this.CreateBootstrapperApplicationDllElement(element); - - if (xBADll != null) - { - element.Add(Environment.NewLine); - element.Add(xBADll); - element.Add(Environment.NewLine); - } - } - } - - private XElement CreateBootstrapperApplicationDllElement(XElement element) - { - XElement xBADll = null; - var xSource = element.Attribute("SourceFile"); - var xDpiAwareness = element.Attribute("DpiAwareness"); - - if (xSource != null) - { - if (xBADll != null || CreateBADllElement(element, out xBADll)) - { - MoveAttribute(element, "SourceFile", xBADll); - MoveAttribute(element, "Name", xBADll); - } - } - else if (xDpiAwareness != null || this.SourceVersion < 4) // older code might be relying on old behavior of first Payload element being the BA dll. - { - var xFirstChild = element.Elements().FirstOrDefault(); - if (xFirstChild?.Name == PayloadElementName) - { - if (xBADll != null || CreateBADllElement(element, out xBADll)) - { - var attributes = xFirstChild.Attributes().ToList(); - xFirstChild.Remove(); - - foreach (var attribute in attributes) - { - xBADll.Add(attribute); - } - } - } - else - { - this.OnError(ConverterTestType.BootstrapperApplicationDllRequired, element, "The new BootstrapperApplicationDll element is required but could not be added automatically since the bootstrapper application dll was not directly specified."); - } - } - - if (xDpiAwareness != null) - { - if (xBADll != null || CreateBADllElement(element, out xBADll)) - { - MoveAttribute(element, "DpiAwareness", xBADll); - } - } - else if (this.SourceVersion < 4 && xBADll != null && - this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplicationDll DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default")) - { - xBADll.Add(new XAttribute("DpiAwareness", "unaware")); - } - - return xBADll; - - bool CreateBADllElement(XObject node, out XElement xCreatedBADll) - { - var create = this.OnError(ConverterTestType.BootstrapperApplicationDll, node, "The bootstrapper application dll is now specified in the BootstrapperApplicationDll element."); - xCreatedBADll = create ? new XElement(BootstrapperApplicationDllElementName) : null; - return create; - } - } - - private void ConvertBootstrapperApplicationRefElement(XElement element) - { - var xUseUILanguages = element.Attribute(BalUseUILanguagesName); - if (xUseUILanguages != null && - this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior.")) - { - xUseUILanguages.Remove(); - } - - var xId = element.Attribute("Id"); - if (xId != null) - { - XName balBAName = null; - XName oldBalBAName = null; - string theme = null; - - switch (xId.Value) - { - case "WixStandardBootstrapperApplication.RtfLicense": - balBAName = BalStandardBootstrapperApplicationName; - theme = "rtfLicense"; - break; - case "WixStandardBootstrapperApplication.RtfLargeLicense": - balBAName = BalStandardBootstrapperApplicationName; - theme = "rtfLargeLicense"; - break; - case "WixStandardBootstrapperApplication.HyperlinkLicense": - balBAName = BalStandardBootstrapperApplicationName; - theme = "hyperlinkLicense"; - break; - case "WixStandardBootstrapperApplication.HyperlinkLargeLicense": - balBAName = BalStandardBootstrapperApplicationName; - theme = "hyperlinkLargeLicense"; - break; - case "WixStandardBootstrapperApplication.HyperlinkSidebarLicense": - balBAName = BalStandardBootstrapperApplicationName; - theme = "hyperlinkSidebarLicense"; - break; - case "WixStandardBootstrapperApplication.Foundation": - balBAName = BalStandardBootstrapperApplicationName; - theme = "none"; - break; - case "ManagedBootstrapperApplicationHost": - case "ManagedBootstrapperApplicationHost.RtfLicense": - balBAName = BalManagedBootstrapperApplicationHostName; - theme = "standard"; - break; - case "ManagedBootstrapperApplicationHost.Minimal": - case "ManagedBootstrapperApplicationHost.RtfLicense.Minimal": - case "ManagedBootstrapperApplicationHost.Foundation": - balBAName = BalManagedBootstrapperApplicationHostName; - theme = "none"; - break; - case "DotNetCoreBootstrapperApplicationHost": - case "DotNetCoreBootstrapperApplicationHost.RtfLicense": - balBAName = BalNewDotNetCoreBootstrapperApplicationName; - oldBalBAName = BalOldDotNetCoreBootstrapperApplicationName; - theme = "standard"; - break; - case "DotNetCoreBootstrapperApplicationHost.Minimal": - case "DotNetCoreBootstrapperApplicationHost.RtfLicense.Minimal": - case "DotNetCoreBootstrapperApplicationHost.Foundation": - balBAName = BalNewDotNetCoreBootstrapperApplicationName; - oldBalBAName = BalOldDotNetCoreBootstrapperApplicationName; - theme = "none"; - break; - } - - if (balBAName != null && theme != null && - this.OnError(ConverterTestType.BalBootstrapperApplicationRefToElement, element, "Built-in bootstrapper applications must be referenced through their custom element")) - { - element.Name = BootstrapperApplicationElementName; - xId.Remove(); - this.ConvertBalBootstrapperApplicationRef(element, theme, balBAName, oldBalBAName); - } - } - } - - private void ConvertApprovedExeForElevationElement(XElement element) - { - this.RenameWin64ToBitness(element); - } - - private void ConvertBalBootstrapperApplicationRef(XElement element, string theme, XName balBAElementName, XName oldBalBAElementName = null) - { - var xBalBa = element.Element(oldBalBAElementName ?? balBAElementName); - if (xBalBa == null) - { - xBalBa = new XElement(balBAElementName); - element.Add(Environment.NewLine); - element.Add(xBalBa); - element.Add(Environment.NewLine); - } - else if (oldBalBAElementName != null) - { - xBalBa.Name = BalNewDotNetCoreBootstrapperApplicationName; - } - - if (theme != "standard") - { - xBalBa.Add(new XAttribute("Theme", theme)); - } - } - - private void ConvertCatalogElement(XElement element) - { - if (this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The Catalog element is obsolete. Signature validation is no longer supported. The element will be removed.")) - { - element.Remove(); - } - } - - private void ConvertColumnElement(XElement element) - { - var category = element.Attribute("Category"); - if (category != null) - { - var camelCaseValue = LowercaseFirstChar(category.Value); - if (category.Value != camelCaseValue && - this.OnError(ConverterTestType.ColumnCategoryCamelCase, element, "The CustomTable Category attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", category.Name)) - { - category.Value = camelCaseValue; - } - } - - var modularization = element.Attribute("Modularize"); - if (modularization != null) - { - var camelCaseValue = LowercaseFirstChar(modularization.Value); - if (modularization.Value != camelCaseValue && - this.OnError(ConverterTestType.ColumnModularizeCamelCase, element, "The CustomTable Modularize attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", modularization.Name)) - { - modularization.Value = camelCaseValue; - } - } - } - - private void ConvertCustomTableElement(XElement element) - { - var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); - if (bootstrapperApplicationData?.Value == "no") - { - if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) - { - bootstrapperApplicationData.Remove(); - } - } - else - { - if (element.Elements(ColumnElementName).Any() || bootstrapperApplicationData != null) - { - // Table definition - if (bootstrapperApplicationData != null) - { - switch (this.CustomTableSetting) - { - case CustomTableTarget.Bundle: - if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'BundleCustomData' element for Bundles.", bootstrapperApplicationData.Name)) - { - element.Name = WixConverter.BundleCustomDataElementName; - bootstrapperApplicationData.Remove(); - this.ConvertCustomTableElementToBundle(element); - } - break; - case CustomTableTarget.Msi: - if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) - { - element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); - bootstrapperApplicationData.Remove(); - } - break; - default: - this.OnError(ConverterTestType.CustomTableNotAlwaysConvertable, element, "The CustomTable element contains deprecated '{0}' attribute so can't be converted. Use the 'Unreal' attribute for MSI. Use the 'BundleCustomData' element for Bundles. Use the --custom-table argument to force conversion to 'msi' or 'bundle'", bootstrapperApplicationData.Name); - break; - } - } - } - else - { - // Table ref - switch (this.CustomTableSetting) - { - case CustomTableTarget.Bundle: - if (this.OnError(ConverterTestType.CustomTableRef, element, "CustomTable elements that don't contain the table definition are now BundleCustomDataRef for Bundles.")) - { - element.Name = WixConverter.BundleCustomDataRefElementName; - this.ConvertCustomTableElementToBundle(element); - } - break; - case CustomTableTarget.Msi: - if (this.OnError(ConverterTestType.CustomTableRef, element, "CustomTable elements that don't contain the table definition are now CustomTableRef for MSI.")) - { - element.Name = WixConverter.CustomTableRefElementName; - } - break; - default: - this.OnError(ConverterTestType.CustomTableNotAlwaysConvertable, element, "The CustomTable element contains no 'Column' elements so can't be converted. Use the 'CustomTableRef' element for MSI. Use the 'BundleCustomDataRef' element for Bundles. Use the --custom-table argument to force conversion to 'msi' or 'bundle'"); - break; - } - } - } - } - - private void ConvertCustomTableElementToBundle(XElement element) - { - foreach (var xColumn in element.Elements(ColumnElementName)) - { - xColumn.Name = WixConverter.BundleAttributeDefinitionElementName; - - foreach (var xAttribute in xColumn.Attributes().ToList()) - { - if (xAttribute.Name.LocalName != "Id" && - (xAttribute.Name.Namespace == WixConverter.Wix3Namespace || - xAttribute.Name.Namespace == WixConverter.WixNamespace || - String.IsNullOrEmpty(xAttribute.Name.Namespace.NamespaceName))) - { - xAttribute.Remove(); - } - } - } - - foreach (var xRow in element.Elements(RowElementName)) - { - xRow.Name = WixConverter.BundleElementElementName; - - foreach (var xData in xRow.Elements(DataElementName)) - { - xData.Name = WixConverter.BundleAttributeElementName; - - var xColumn = xData.Attribute("Column"); - if (xColumn != null) - { - xData.Add(new XAttribute("Id", xColumn.Value)); - xColumn.Remove(); - } - - this.ConvertInnerTextToAttribute(xData, "Value"); - } - } - } - - private void ConvertControlElement(XElement element) - { - var remove = new List(); - - foreach (var xCondition in element.Elements(ConditionElementName)) - { - var action = UppercaseFirstChar(xCondition.Attribute("Action")?.Value); - if (!String.IsNullOrEmpty(action) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}Condition' attribute instead.", xCondition.Name.LocalName, action)) - { - element.Add(new XAttribute(action + "Condition", text)); - remove.Add(xCondition); - } - } - - for (var i = remove.Count - 1; i >= 0; i--) - { - remove[i].Remove(); - } - } - - private void ConvertComponentElement(XElement element) - { - var guid = element.Attribute("Guid"); - if (guid != null && guid.Value == "*") - { - if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Component Guid attribute is unnecessary. Remove the attribute to remove the redundancy.")) - { - guid.Remove(); - } - } - - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - if (TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) - { - element.Add(new XAttribute("Condition", text)); - xCondition.Remove(); - } - } - - this.RenameWin64ToBitness(element); - } - - private void ConvertDirectoryElement(XElement element) - { - if (null == element.Attribute("Name")) - { - var attribute = element.Attribute("ShortName"); - if (null != attribute) - { - var shortName = attribute.Value; - if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) - { - element.Add(new XAttribute("Name", shortName)); - attribute.Remove(); - } - } - } - - var id = element.Attribute("Id")?.Value; - - if (id == "TARGETDIR" && - this.OnError(ConverterTestType.TargetDirDeprecated, element, "The TARGETDIR directory should not longer be explicitly defined. Remove the Directory element with Id attribute 'TARGETDIR'.")) - { - var parentElement = element.Parent; - - element.Remove(); - - if (parentElement.FirstNode is XText text && String.IsNullOrWhiteSpace(text.Value)) - { - parentElement.FirstNode.Remove(); - } - - foreach (var child in element.Nodes()) - { - parentElement.Add(child); - } - - element.RemoveAll(); - - if (parentElement.FirstNode is XText textAgain && String.IsNullOrWhiteSpace(textAgain.Value)) - { - parentElement.FirstNode.Remove(); - } - } - else if (id != null && - WindowsInstallerStandard.IsStandardDirectory(id) && - this.OnError(ConverterTestType.DefiningStandardDirectoryDeprecated, element, "Standard directories such as '{0}' should no longer be defined using the Directory element. Use the StandardDirectory element instead.", id)) - { - element.Name = StandardDirectoryElementName; - - foreach (var attrib in element.Attributes().Where(a => a.Name.LocalName != "Id").ToList()) - { - attrib.Remove(); - } - } - } - - private void ConvertFeatureElement(XElement element) - { - var xAbsent = element.Attribute("Absent"); - if (xAbsent != null && - this.OnError(ConverterTestType.FeatureAbsentAttributeReplaced, element, "The Feature element's Absent attribute has been replaced with the AllowAbsent attribute. Use the 'AllowAbsent' attribute instead.")) - { - if (xAbsent.Value == "disallow") - { - element.Add(new XAttribute("AllowAbsent", "no")); - } - xAbsent.Remove(); - } - - var xAllowAdvertise = element.Attribute("AllowAdvertise"); - if (xAllowAdvertise != null) - { - if ((xAllowAdvertise.Value == "system" || xAllowAdvertise.Value == "allow") && - this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value is deprecated. Set the value to 'yes' instead.", xAllowAdvertise.Value)) - { - xAllowAdvertise.Value = "yes"; - } - else if (xAllowAdvertise.Value == "disallow" && - this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value is deprecated. Remove the value instead.", xAllowAdvertise.Value)) - { - xAllowAdvertise.Remove(); - } - } - - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - var level = xCondition.Attribute("Level")?.Value; - if (!String.IsNullOrEmpty(level) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Level' element instead.", xCondition.Name.LocalName)) - { - xCondition.AddAfterSelf(new XElement(LevelElementName, - new XAttribute("Value", level), - new XAttribute("Condition", text) - )); - xCondition.Remove(); - } - } - } - - private void ConvertFileElement(XElement element) - { - if (this.SourceVersion < 4 && null == element.Attribute("Id")) - { - var attribute = element.Attribute("Name"); - - if (null == attribute) - { - attribute = element.Attribute("Source"); - } - - if (null != attribute) - { - var name = Path.GetFileName(attribute.Value); - - if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the v3 default", name)) - { - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - element.Add(new XAttribute("Id", GetIdentifierFromName(name))); - element.Add(attributes); - } - } - } - } - - private void ConvertFragmentElement(XElement element) - { - var remove = new List(); - - foreach (var xCondition in element.Elements(ConditionElementName)) - { - var message = xCondition.Attribute("Message")?.Value; - - if (!String.IsNullOrEmpty(message) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) - { - xCondition.AddAfterSelf(new XElement(LaunchElementName, - new XAttribute("Condition", text), - new XAttribute("Message", message) - )); - remove.Add(xCondition); - } - } - - for (var i = remove.Count - 1; i >= 0; i--) - { - remove[i].Remove(); - } - } - - private void ConvertFirewallRemoteAddressElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); - - private void ConvertExePackageElement(XElement element) - { - this.ConvertSuppressSignatureValidation(element); - - foreach (var attributeName in new[] { "InstallCommand", "RepairCommand", "UninstallCommand" }) - { - var newName = attributeName.Replace("Command", "Arguments"); - var attribute = element.Attribute(attributeName); - - if (attribute != null && - this.OnError(ConverterTestType.RenameExePackageCommandToArguments, element, "The {0} element {1} attribute has been renamed {2}.", element.Name.LocalName, attribute.Name.LocalName, newName)) - { - element.Add(new XAttribute(newName, attribute.Value)); - attribute.Remove(); - } - } - } - - private void ConvertPermissionExElement(XElement element) - { - var xCondition = element.Element(ConditionElementName); - if (xCondition != null) - { - if (TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) - { - element.Add(new XAttribute("Condition", text)); - xCondition.Remove(); - } - } - } - - private void ConvertProgressTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); - - private void ConvertModuleElement(XElement element) - { - if (element.Attribute("Guid") == null // skip already-converted Module elements - && this.OnError(ConverterTestType.ModuleAndPackageRenamed, element, "The Module and Package elements have been renamed and reorganized for simplicity.")) - { - var xModule = element; - - var xSummaryInformation = xModule.Element(PackageElementName); - if (xSummaryInformation != null) - { - xSummaryInformation.Name = SummaryInformationElementName; - - var xInstallerVersion = xSummaryInformation.Attribute("InstallerVersion"); - if (this.SourceVersion < 4 && xInstallerVersion == null) - { - this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Module element."); - } - - RemoveAttribute(xSummaryInformation, "AdminImage"); - RemoveAttribute(xSummaryInformation, "Comments"); - MoveAttribute(xSummaryInformation, "Id", xModule, "Guid"); - MoveAttribute(xSummaryInformation, "InstallerVersion", xModule); - RemoveAttribute(xSummaryInformation, "Languages"); - RemoveAttribute(xSummaryInformation, "Platform"); - RemoveAttribute(xSummaryInformation, "Platforms"); - RemoveAttribute(xSummaryInformation, "ReadOnly"); - MoveAttribute(xSummaryInformation, "SummaryCodepage", xSummaryInformation, "Codepage", defaultValue: "1252"); - - if (!xSummaryInformation.HasAttributes) - { - xSummaryInformation.Remove(); - } - } - } - } - - private void ConvertProductElement(XElement element) - { - var id = element.Attribute("Id"); - if (id != null && id.Value == "*") - { - if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Product Id attribute is unnecessary. Remove the attribute to remove the redundancy.")) - { - id.Remove(); - } - } - - var xConditions = element.Elements(ConditionElementName).ToList(); - foreach (var xCondition in xConditions) - { - var message = xCondition.Attribute("Message")?.Value; - - if (!String.IsNullOrEmpty(message) && - TryGetInnerText(xCondition, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) - { - xCondition.AddAfterSelf(new XElement(LaunchElementName, - new XAttribute("Condition", text), - new XAttribute("Message", message) - )); - xCondition.Remove(); - } - } - - var xMediaTemplate = element.Element(MediaTemplateElementName); - if (xMediaTemplate?.HasAttributes == false - && this.OnError(ConverterTestType.DefaultMediaTemplate, element, "A MediaTemplate with no attributes set is now provided by default. Remove the element.")) - { - xMediaTemplate.Remove(); - } - - if (this.OnError(ConverterTestType.ProductAndPackageRenamed, element, "The Product and Package elements have been renamed and reorganized for simplicity.")) - { - var xPackage = element; - xPackage.Name = PackageElementName; - - var xSummaryInformation = xPackage.Element(PackageElementName); - if (xSummaryInformation != null) - { - xSummaryInformation.Name = SummaryInformationElementName; - - var xInstallerVersion = xSummaryInformation.Attribute("InstallerVersion"); - if (this.SourceVersion < 4 && xInstallerVersion == null) - { - this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Package element."); - } - - if (xSummaryInformation.Attribute("Compressed") == null) - { - xPackage.SetAttributeValue("Compressed", "no"); - } - else - { - MoveAttribute(xSummaryInformation, "Compressed", xPackage, defaultValue: "yes"); - } - - RemoveAttribute(xSummaryInformation, "AdminImage"); - RemoveAttribute(xSummaryInformation, "Comments"); - RemoveAttribute(xSummaryInformation, "Id"); - MoveAttribute(xSummaryInformation, "InstallerVersion", xPackage, defaultValue: "500"); - MoveAttribute(xSummaryInformation, "InstallScope", xPackage, "Scope", defaultValue: "perMachine"); - RemoveAttribute(xSummaryInformation, "Languages"); - RemoveAttribute(xSummaryInformation, "Platform"); - RemoveAttribute(xSummaryInformation, "Platforms"); - RemoveAttribute(xSummaryInformation, "ReadOnly"); - MoveAttribute(xSummaryInformation, "ShortNames", xPackage); - MoveAttribute(xSummaryInformation, "SummaryCodepage", xSummaryInformation, "Codepage", defaultValue: "1252"); - MoveAttribute(xPackage, "Id", xPackage, "ProductCode"); - - var xInstallPrivileges = xSummaryInformation.Attribute("InstallPrivileges"); - switch (xInstallPrivileges?.Value) - { - case "limited": - xPackage.SetAttributeValue("Scope", "perUser"); - break; - case "elevated": - { - var xAllUsers = xPackage.Elements(PropertyElementName).SingleOrDefault(p => p.Attribute("Id")?.Value == "ALLUSERS"); - if (xAllUsers?.Attribute("Value")?.Value == "1") - { - xAllUsers?.Remove(); - } - } - break; - } - - xInstallPrivileges?.Remove(); - - if (!xSummaryInformation.HasAttributes) - { - xSummaryInformation.Remove(); - } - } - } - } - - private static void MoveAttribute(XElement xSource, string attributeName, XElement xDestination, string destinationAttributeName = null, string defaultValue = null) - { - var xAttribute = xSource.Attribute(attributeName); - if (xAttribute != null && (defaultValue == null || xAttribute.Value != defaultValue)) - { - xDestination.SetAttributeValue(destinationAttributeName ?? attributeName, xAttribute.Value); - } - - xAttribute?.Remove(); - } - - private static void RemoveAttribute(XElement xSummaryInformation, string attributeName) - { - var xAttribute = xSummaryInformation.Attribute(attributeName); - xAttribute?.Remove(); - } - - private void ConvertPropertyRefElement(XElement element) - { - var newElementName = String.Empty; - - var id = element.Attribute("Id"); - switch (id?.Value) - { - case "WIX_SUITE_BACKOFFICE": - case "WIX_SUITE_BLADE": - case "WIX_SUITE_COMMUNICATIONS": - case "WIX_SUITE_COMPUTE_SERVER": - case "WIX_SUITE_DATACENTER": - case "WIX_SUITE_EMBEDDED_RESTRICTED": - case "WIX_SUITE_EMBEDDEDNT": - case "WIX_SUITE_ENTERPRISE": - case "WIX_SUITE_MEDIACENTER": - case "WIX_SUITE_PERSONAL": - case "WIX_SUITE_SECURITY_APPLIANCE": - case "WIX_SUITE_SERVERR2": - case "WIX_SUITE_SINGLEUSERTS": - case "WIX_SUITE_SMALLBUSINESS": - case "WIX_SUITE_SMALLBUSINESS_RESTRICTED": - case "WIX_SUITE_STARTER": - case "WIX_SUITE_STORAGE_SERVER": - case "WIX_SUITE_TABLETPC": - case "WIX_SUITE_TERMINAL": - case "WIX_SUITE_WH_SERVER": - newElementName = "QueryWindowsSuiteInfo"; - break; - case "WIX_DIR_ADMINTOOLS": - case "WIX_DIR_ALTSTARTUP": - case "WIX_DIR_CDBURN_AREA": - case "WIX_DIR_COMMON_ADMINTOOLS": - case "WIX_DIR_COMMON_ALTSTARTUP": - case "WIX_DIR_COMMON_DOCUMENTS": - case "WIX_DIR_COMMON_FAVORITES": - case "WIX_DIR_COMMON_MUSIC": - case "WIX_DIR_COMMON_PICTURES": - case "WIX_DIR_COMMON_VIDEO": - case "WIX_DIR_COOKIES": - case "WIX_DIR_DESKTOP": - case "WIX_DIR_HISTORY": - case "WIX_DIR_INTERNET_CACHE": - case "WIX_DIR_MYMUSIC": - case "WIX_DIR_MYPICTURES": - case "WIX_DIR_MYVIDEO": - case "WIX_DIR_NETHOOD": - case "WIX_DIR_PERSONAL": - case "WIX_DIR_PRINTHOOD": - case "WIX_DIR_PROFILE": - case "WIX_DIR_RECENT": - case "WIX_DIR_RESOURCES": - newElementName = "QueryWindowsDirectories"; - break; - case "WIX_DWM_COMPOSITION_ENABLED": - case "WIX_WDDM_DRIVER_PRESENT": - newElementName = "QueryWindowsDriverInfo"; - break; - case "WIX_ACCOUNT_LOCALSYSTEM": - case "WIX_ACCOUNT_LOCALSERVICE": - case "WIX_ACCOUNT_NETWORKSERVICE": - case "WIX_ACCOUNT_ADMINISTRATORS": - case "WIX_ACCOUNT_USERS": - case "WIX_ACCOUNT_GUESTS": - case "WIX_ACCOUNT_PERFLOGUSERS": - case "WIX_ACCOUNT_PERFLOGUSERS_NODOMAIN": - newElementName = "QueryWindowsWellKnownSIDs"; - break; - } - - if (!String.IsNullOrEmpty(newElementName) - && this.OnError(ConverterTestType.UtilReferencesReplaced, element, "Custom action and property reference {0} to WixUtilExtension have been replaced with strongly-typed elements.", id)) - { - element.AddAfterSelf(new XElement(WixUtilNamespace + newElementName)); - element.Remove(); - } - } - - private void ConvertCustomActionRefElement(XElement element) - { - var newElementName = String.Empty; - - var id = element.Attribute("Id"); - switch (id?.Value) - { - case "WixBroadcastSettingChange": - case "WixBroadcastEnvironmentChange": - case "WixCheckRebootRequired": - case "WixExitEarlyWithSuccess": - case "WixFailWhenDeferred": - case "WixWaitForEvent": - case "WixWaitForEventDeferred": - newElementName = id?.Value.Substring(3); // strip leading Wix - break; - } - - if (!String.IsNullOrEmpty(newElementName) - && this.OnError(ConverterTestType.UtilReferencesReplaced, element, "Custom action and property reference {0} to WixUtilExtension have been replaced with strongly-typed elements.", id)) - { - element.AddAfterSelf(new XElement(WixUtilNamespace + newElementName)); - element.Remove(); - } - } - - private void ConvertPublishElement(XElement element) - { - this.ConvertInnerTextToAttribute(element, "Condition"); - - var xCondition = element.Attribute("Condition"); - if (xCondition?.Value == "1" && - this.OnError(ConverterTestType.PublishConditionOneUnnecessary, element, "Adding Condition='1' on {0} elements is no longer necessary. Remove the Condition attribute.", xCondition.Name.LocalName)) - { - xCondition.Remove(); - } - } - - private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertRegistryKeyElement(XElement element) - { - var xAction = element.Attribute("Action"); - - if (xAction != null - && this.OnError(ConverterTestType.RegistryKeyActionObsolete, element, "The RegistryKey element's Action attribute is obsolete. Action='create' will be converted to ForceCreateOnInstall='yes'. Action='createAndRemoveOnUninstall' will be converted to ForceCreateOnInstall='yes' and ForceDeleteOnUninstall='yes'.")) - { - switch (xAction?.Value) - { - case "create": - element.SetAttributeValue("ForceCreateOnInstall", "yes"); - break; - case "createAndRemoveOnUninstall": - element.SetAttributeValue("ForceCreateOnInstall", "yes"); - element.SetAttributeValue("ForceDeleteOnUninstall", "yes"); - break; - } - - xAction.Remove(); - } - } - - private void ConvertRemotePayloadElement(XElement element) - { - var xParent = element.Parent; - - if (xParent.Name == ExePackageElementName && - this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'ExePackagePayload' instead.")) - { - element.Name = ExePackagePayloadElementName; - } - else if (xParent.Name == MsuPackageElementName && - this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'MsuPackagePayload' instead.")) - { - element.Name = MsuPackagePayloadElementName; - } - - var xName = xParent.Attribute("Name"); - if (xName != null && - this.OnError(ConverterTestType.NameAttributeMovedToRemotePayload, xParent, "The Name attribute must be specified on the child XxxPackagePayload element when using a remote payload.")) - { - element.SetAttributeValue("Name", xName.Value); - xName.Remove(); - } - - var xDownloadUrl = xParent.Attribute("DownloadUrl"); - if (xDownloadUrl != null && - this.OnError(ConverterTestType.DownloadUrlAttributeMovedToRemotePayload, xParent, "The DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload.")) - { - element.SetAttributeValue("DownloadUrl", xDownloadUrl.Value); - xDownloadUrl.Remove(); - } - - var xCompressed = xParent.Attribute("Compressed"); - if (xCompressed != null && - this.OnError(ConverterTestType.CompressedAttributeUnnecessaryForRemotePayload, xParent, "The Compressed attribute should not be specified when using a remote payload.")) - { - xCompressed.Remove(); - } - - this.OnError(ConverterTestType.BurnHashAlgorithmChanged, element, "The hash algorithm for bundles changed from SHA1 to SHA512."); - - this.RemoveAttributeIfPresent(element, "CertificatePublicKey", ConverterTestType.BundleSignatureValidationObsolete, "The {0} element contains obsolete '{1}' attribute. Signature validation is no longer supported. The attribute will be removed."); - this.RemoveAttributeIfPresent(element, "CertificateThumbprint", ConverterTestType.BundleSignatureValidationObsolete, "The {0} element contains obsolete '{1}' attribute. Signature validation is no longer supported. The attribute will be removed."); - } - - private void ConvertRegistrySearchElement(XElement element) - { - this.RenameWin64ToBitness(element); - } - - private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); - - private void ConvertDataElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertSequenceElement(XElement element) - { - foreach (var child in element.Elements()) - { - this.ConvertInnerTextToAttribute(child, "Condition"); - } - } - - private void ConvertServiceArgumentElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertSetDirectoryElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertSetPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertProvidesElement(XElement element) - { - if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Remove the namespace.")) - { - element.Name = ProvidesElementName; - } - - if (element.Parent.Name == ComponentElementName && - this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Add the 'Check' attribute from the WixDependency.wixext to match v3 runtime behavior.")) - { - element.Add(new XAttribute(DependencyCheckAttributeName, "yes")); - } - } - - private void ConvertRequiresElement(XElement element) - { - if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Remove the namespace.")) - { - element.Name = RequiresElementName; - } - - if (element.Parent.Name == ProvidesElementName && - element.Parent.Parent?.Name == ComponentElementName && - this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) - { - element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); - } - } - - private void ConvertRequiresRefElement(XElement element) - { - if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Remove the namespace.")) - { - element.Name = RequiresRefElementName; - } - - if (element.Parent.Name == ProvidesElementName && - element.Parent.Parent?.Name == ComponentElementName && - this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) - { - element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); - } - } - - private void ConvertSuppressSignatureValidation(XElement element) - { - var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); - - if (null != suppressSignatureValidation - && this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The chain package element contains obsolete '{0}' attribute. Signature validation is no longer supported. The attribute will be removed.", suppressSignatureValidation.Name)) - { - suppressSignatureValidation.Remove(); - } - } - - private void ConvertTagElement(XElement element) - { - if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the 'SoftwareTag' element instead.")) - { - element.Name = SoftwareTagElementName; - } - - this.RemoveAttributeIfPresent(element, "Licensed", ConverterTestType.SoftwareTagLicensedObsolete, "The {0} element contains obsolete '{1}' attribute. The attribute will be removed."); - this.RemoveAttributeIfPresent(element, "Type", ConverterTestType.SoftwareTagLicensedObsolete, "The {0} element contains obsolete '{1}' attribute. The attribute will be removed."); - this.RenameWin64ToBitness(element); - } - - private void ConvertTagRefElement(XElement element) - { - if (this.OnError(ConverterTestType.TagRefElementRenamed, element, "The TagRef element has been renamed. Use the 'SoftwareTagRef' element instead.")) - { - element.Name = SoftwareTagRefElementName; - } - } - - private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - private void ConvertWindowsInstallerPackageElement(XElement element) - { - this.ConvertSuppressSignatureValidation(element); - - if (null != element.Attribute("DisplayInternalUI")) - { - this.OnError(ConverterTestType.DisplayInternalUiNotConvertable, element, "The DisplayInternalUI functionality has fundamentally changed and requires BootstrapperApplication support."); - } - } - - private void ConvertVerbElement(XElement element) - { - if (null != element.Attribute("Target")) - { - this.OnError(ConverterTestType.VerbTargetNotConvertable, element, "The Verb/@Target attribute has been replaced with typed @TargetFile and @TargetProperty attributes."); - } - } - - private void ConvertCustomActionElement(XElement xCustomAction) - { - var xBinaryKey = xCustomAction.Attribute("BinaryKey"); - if (xBinaryKey != null && this.OnError(ConverterTestType.CustomActionKeysAreNowRefs, xCustomAction, "The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef.")) - { - xCustomAction.SetAttributeValue("BinaryRef", xBinaryKey.Value); - xBinaryKey.Remove(); - xBinaryKey = xCustomAction.Attribute("BinaryRef"); - } - - var xFileKey = xCustomAction.Attribute("FileKey"); - if (xFileKey != null && this.OnError(ConverterTestType.CustomActionKeysAreNowRefs, xCustomAction, "The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef.")) - { - xCustomAction.SetAttributeValue("FileRef", xFileKey.Value); - xFileKey.Remove(); - } - - if (xBinaryKey?.Value == "WixCA" || xBinaryKey?.Value == "UtilCA") - { - if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X86' instead.")) - { - xBinaryKey.Value = "Wix4UtilCA_X86"; - } - } - - if (xBinaryKey?.Value == "WixCA_x64" || xBinaryKey?.Value == "UtilCA_x64") - { - if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA_x64 custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X64' instead.")) - { - xBinaryKey.Value = "Wix4UtilCA_X64"; - } - } - - var xDllEntry = xCustomAction.Attribute("DllEntry"); - - if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") - { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) - { - xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); - } - } - - var xProperty = xCustomAction.Attribute("Property"); - - if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") - { - if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) - { - xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); - } - } - - var xScript = xCustomAction.Attribute("Script"); - - if (xScript != null && TryGetInnerText(xCustomAction, out var scriptText)) - { - if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptSourceFile' attribute to reference it.", xCustomAction.Name.LocalName)) - { - var scriptFolder = Path.GetDirectoryName(this.SourceFile) ?? String.Empty; - var id = xCustomAction.Attribute("Id")?.Value ?? Guid.NewGuid().ToString("N"); - var ext = (xScript.Value == "jscript") ? ".js" : (xScript.Value == "vbscript") ? ".vbs" : ".txt"; - - var scriptFile = Path.Combine(scriptFolder, id + ext); - File.WriteAllText(scriptFile, scriptText); - - RemoveChildren(xCustomAction); - xCustomAction.Add(new XAttribute("ScriptSourceFile", scriptFile)); - } - } - } - - private void ConvertVariableElement(XElement xVariable) - { - var xType = xVariable.Attribute("Type"); - var xValue = xVariable.Attribute("Value"); - if (this.SourceVersion < 4) - { - if (xType == null) - { - if (WasImplicitlyStringTyped(xValue?.Value) && - this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) - { - xVariable.Add(new XAttribute("Type", "formatted")); - } - } - else if (xType.Value == "string" && - this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) - { - xType.Value = "formatted"; - } - } - } - - private void ConvertPropertyElement(XElement xProperty) - { - var xId = xProperty.Attribute("Id"); - - if (xId.Value == "QtExecCmdTimeout") - { - this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); - } - - this.ConvertInnerTextToAttribute(xProperty, "Value"); - } - - private void ConvertUtilCloseApplicationElementName(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); - - private void ConvertUtilPermissionExElement(XElement element) - { - if (this.SourceVersion < 4 && null == element.Attribute("Inheritable")) - { - var inheritable = element.Parent.Name == CreateFolderElementName; - if (!inheritable) - { - if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default.")) - { - element.Add(new XAttribute("Inheritable", "no")); - } - } - } - } - - private void ConvertUtilRegistrySearchElement(XElement element) - { - this.RenameWin64ToBitness(element); - - if (this.SourceVersion < 4) - { - var result = element.Attribute("Result")?.Value; - if (result == null || result == "value") - { - this.OnError(ConverterTestType.UtilRegistryValueSearchBehaviorChange, element, "Breaking change: util:RegistrySearch for a value no longer clears the variable when the key or value is missing."); - } - } - } - - private void ConvertUtilXmlConfigElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); - - /// - /// Converts a Wix element. - /// - /// The Wix element to convert. - /// The converted element. - private void ConvertElementWithoutNamespace(XElement element) - { - if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) - { - element.Name = WixNamespace.GetName(element.Name.LocalName); - - element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. - - foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) - { - elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); - } - } - } - - private void ConvertInnerTextToAttribute(XElement element, string attributeName) - { - if (TryGetInnerText(element, out var text) && - this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}' attribute instead.", element.Name.LocalName, attributeName)) - { - element.Add(new XAttribute(attributeName, text)); - RemoveChildren(element); - } - } - - void RemoveAttributeIfPresent(XElement element, string attributeName, ConverterTestType type, string format) - { - var xAttribute = element.Attribute(attributeName); - if (null != xAttribute && this.OnError(type, element, format, element.Name.LocalName, xAttribute.Name)) - { - xAttribute.Remove(); - } - } - - private void RenameWin64ToBitness(XElement element) - { - var win64 = element.Attribute("Win64"); - if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The {0} element's Win64 attribute has been renamed. Use the Bitness attribute instead.", element.Name.LocalName)) - { - var value = this.UpdateWin64ValueToBitnessValue(win64); - element.Add(new XAttribute("Bitness", value)); - win64.Remove(); - } - } - - private string UpdateWin64ValueToBitnessValue(XAttribute xWin64Attribute) - { - var value = xWin64Attribute.Value ?? String.Empty; - switch (value) - { - case "yes": - return "always64"; - case "no": - return "always32"; - default: - this.OnError(ConverterTestType.Win64AttributeRenameCannotBeAutomatic, xWin64Attribute, "Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute.", value); - return value; - } - } - - private IEnumerable YieldConverterTypes(IEnumerable types) - { - if (null != types) - { - foreach (var type in types) - { - if (Enum.TryParse(type, true, out var itt)) - { - yield return itt; - } - else // not a known ConverterTestType - { - this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); - } - } - } - } - - private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) - { - foreach (var element in elements) - { - if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) - { - element.Name = ns.GetName(element.Name.LocalName); - } - - // Remove all the attributes and add them back to with their namespace updated (as necessary). - IEnumerable attributes = element.Attributes().ToList(); - element.RemoveAttributes(); - - foreach (var attribute in attributes) - { - var convertedAttribute = attribute; - - if (attribute.IsNamespaceDeclaration) - { - if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) - { - if (ns == XNamespace.None) - { - continue; - } - - convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); - } - } - else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) - { - convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); - } - - element.Add(convertedAttribute); - } - } - } - - /// - /// Determine if the whitespace preceding a node is appropriate for its depth level. - /// - /// Indentation value to use when validating leading whitespace. - /// The depth level that should match this whitespace. - /// The whitespace to validate. - /// true if the whitespace is legal; false otherwise. - private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) - { - // Strip off leading newlines; there can be an arbitrary number of these. - whitespace = whitespace.TrimStart(XDocumentNewLine); - - var indentation = new string(' ', level * indentationAmount); - - return whitespace == indentation; - } - - /// - /// Fix the whitespace in a whitespace node. - /// - /// Indentation value to use when validating leading whitespace. - /// The depth level of the desired whitespace. - /// The whitespace node to fix. - private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) - { - var value = new StringBuilder(whitespace.Value.Length); - - // Keep any previous preceeding new lines. - var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); - - // Ensure there is always at least one new line before the indentation. - value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); - - whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); - } - - /// - /// Removes unused namespaces from the element and its children. - /// - /// Root element to start at. - private void RemoveUnusedNamespaces(XElement root) - { - var declarations = new List(); - var namespaces = new HashSet(); - - VisitElement(root, x => - { - if (x is XAttribute a && a.IsNamespaceDeclaration) - { - declarations.Add(a); - namespaces.Add(a.Value); - } - return true; - }); - - foreach (var ns in namespaces.ToList()) - { - VisitElement(root, x => - { - if ((x is XElement e && e.Name.Namespace == ns) || - (x is XAttribute a && !a.IsNamespaceDeclaration && a.Name.Namespace == ns)) - { - namespaces.Remove(ns); - return false; - } - - return true; - }); - } - - foreach (var declaration in declarations) - { - if (namespaces.Contains(declaration.Value) && - this.OnError(ConverterTestType.RemoveUnusedNamespaces, declaration, "The namespace '{0}' is not used. Remove unused namespaces.", declaration.Value)) - { - declaration.Remove(); - } - } - } - - /// - /// Output an error message to the console. - /// - /// The type of converter test. - /// The node that caused the error. - /// Detailed error message. - /// Additional formatted string arguments. - /// Returns true indicating that action should be taken on this error, and false if it should be ignored. - private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) - { - // Ignore the error if explicitly ignored or outside the range of the current operation. - if (this.IgnoreErrors.Contains(converterTestType) || - (this.Operation == ConvertOperation.Convert && converterTestType < ConverterTestType.EndIgnoreInConvert) || - (this.Operation == ConvertOperation.Format && converterTestType > ConverterTestType.BeginIgnoreInFormat)) - { - return false; - } - - // Increase the error count. - this.Errors++; - - var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wix.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); - var warning = this.ErrorsAsWarnings.Contains(converterTestType); - var display = String.Format(CultureInfo.CurrentCulture, message, args); - - var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); - - this.Messaging.Write(msg); - - return true; - } - - /// - /// Return an identifier based on passed file/directory name - /// - /// File/directory name to generate identifer from - /// A version of the name that is a legal identifier. - /// This is duplicated from WiX's Common class. - private static string GetIdentifierFromName(string name) - { - var result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". - - // MSI identifiers must begin with an alphabetic character or an - // underscore. Prefix all other values with an underscore. - if (AddPrefix.IsMatch(name)) - { - result = String.Concat("_", result); - } - - return result; - } - - private static string LowercaseFirstChar(string value) - { - if (!String.IsNullOrEmpty(value)) - { - var c = Char.ToLowerInvariant(value[0]); - if (c != value[0]) - { - var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; - return c + remainder; - } - } - - return value; - } - - private static string UppercaseFirstChar(string value) - { - if (!String.IsNullOrEmpty(value)) - { - var c = Char.ToUpperInvariant(value[0]); - if (c != value[0]) - { - var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; - return c + remainder; - } - } - - return value; - } - - private static bool TryGetInnerText(XElement element, out string value) - { - value = null; - - var nodes = element.Nodes(); - - if (nodes.All(e => e.NodeType == XmlNodeType.Text || e.NodeType == XmlNodeType.CDATA)) - { - value = String.Join(String.Empty, nodes.Cast().Select(TrimTextValue)); - } - - return !String.IsNullOrEmpty(value); - } - - private static bool IsTextNode(XNode node, out XText text) - { - text = null; - - if (node.NodeType == XmlNodeType.Text || node.NodeType == XmlNodeType.CDATA) - { - text = (XText)node; - } - - return text != null; - } - - private static void TrimLeadingText(XDocument document) - { - while (IsTextNode(document.Nodes().FirstOrDefault(), out var text)) - { - text.Remove(); - } - } - - private static string TrimTextValue(XText text) - { - var value = text.Value; - - if (String.IsNullOrEmpty(value)) - { - return String.Empty; - } - else if (text.NodeType == XmlNodeType.CDATA && String.IsNullOrWhiteSpace(value)) - { - return " "; - } - - return value.Trim(); - } - - private static void RemoveChildren(XElement element) - { - var nodes = element.Nodes().ToList(); - foreach (var node in nodes) - { - node.Remove(); - } - } - - private static bool VisitElement(XElement element, Func visitor) - { - if (!visitor(element)) - { - return false; - } - - if (!element.Attributes().All(a => visitor(a))) - { - return false; - } - - return element.Elements().All(e => VisitElement(e, visitor)); - } - - private static bool WasImplicitlyStringTyped(string value) - { - if (value == null) - { - return false; - } - else if (value.StartsWith("v", StringComparison.OrdinalIgnoreCase)) - { - if (Int32.TryParse(value.Substring(1), NumberStyles.None, CultureInfo.InvariantCulture.NumberFormat, out var _)) - { - return false; - } - else if (Version.TryParse(value.Substring(1), out var _)) - { - return false; - } - } - else if (Int64.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture.NumberFormat, out var _)) - { - return false; - } - - return true; - } - - /// - /// Converter test types. These are used to condition error messages down to warnings. - /// - private enum ConverterTestType - { - /// - /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. - /// - ConverterTestTypeUnknown, - - /// - /// Displayed when an XML loading exception has occurred. - /// - XmlException, - - /// - /// Displayed when the whitespace preceding a node is wrong. - /// - WhitespacePrecedingNodeWrong, - - /// - /// Displayed when the whitespace preceding an end element is wrong. - /// - WhitespacePrecedingEndElementWrong, - - /// Before this point, ignore errors on convert operation - EndIgnoreInConvert, - - /// - /// Displayed when the XML declaration is present in the source file. - /// - DeclarationPresent, - - /// - /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. - /// - UnauthorizedAccessException, - - /// After this point, ignore errors on format operation - BeginIgnoreInFormat, - - /// - /// Displayed when the xmlns attribute is missing from the document element. - /// - XmlnsMissing, - - /// - /// Displayed when the xmlns attribute on the document element is wrong. - /// - XmlnsValueWrong, - - /// - /// Displayed when inner text contains a deprecated $(loc.xxx) reference. - /// - DeprecatedLocalizationVariablePrefixInTextValue, - - /// - /// Displayed when an attribute value contains a deprecated $(loc.xxx) reference. - /// - DeprecatedLocalizationVariablePrefixInAttributeValue, - - /// - /// Assign an identifier to a File element when on Id attribute is specified. - /// - AssignAnonymousFileId, - - /// - /// SuppressSignatureValidation attribute is obsolete and corresponding functionality removed. - /// - BundleSignatureValidationObsolete, - - /// - /// WixCA Binary/@Id has been renamed to UtilCA. - /// - WixCABinaryIdRenamed, - - /// - /// QtExec custom actions have been renamed. - /// - QuietExecCustomActionsRenamed, - - /// - /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. - /// - QtExecCmdTimeoutAmbiguous, - - /// - /// Directory/@ShortName may only be specified with Directory/@Name. - /// - AssignDirectoryNameFromShortName, - - /// - /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal for MSI. Use BundleCustomData element for Bundles. - /// - BootstrapperApplicationDataDeprecated, - - /// - /// Inheritable is new and is now defaulted to 'yes' which is a change in behavior for all but children of CreateFolder. - /// - AssignPermissionExInheritable, - - /// - /// Column element's Category attribute is camel-case. - /// - ColumnCategoryCamelCase, - - /// - /// Column element's Modularize attribute is camel-case. - /// - ColumnModularizeCamelCase, - - /// - /// Inner text value should move to an attribute. - /// - InnerTextDeprecated, - - /// - /// Explicit auto-GUID unnecessary. - /// - AutoGuidUnnecessary, - - /// - /// The Feature Absent attribute renamed to AllowAbsent. - /// - FeatureAbsentAttributeReplaced, - - /// - /// The Feature AllowAdvertise attribute value deprecated. - /// - FeatureAllowAdvertiseValueDeprecated, - - /// - /// The Condition='1' attribute is unnecessary on Publish elements. - /// - PublishConditionOneUnnecessary, - - /// - /// DpiAwareness is new and is defaulted to 'perMonitorV2' which is a change in behavior. - /// - AssignBootstrapperApplicationDpiAwareness, - - /// - /// The string variable type was previously treated as formatted. - /// - AssignVariableTypeFormatted, - - /// - /// The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef. - /// - CustomActionKeysAreNowRefs, - - /// - /// The Product and Package elements have been renamed and reorganized. - /// - ProductAndPackageRenamed, - - /// - /// The Module and Package elements have been renamed and reorganized. - /// - ModuleAndPackageRenamed, - - /// - /// A MediaTemplate with no attributes set is now provided by default. - /// - DefaultMediaTemplate, - - /// - /// util:RegistrySearch has breaking change when value is missing. - /// - UtilRegistryValueSearchBehaviorChange, - - /// - /// DisplayInternalUI can't be converted. - /// - DisplayInternalUiNotConvertable, - - /// - /// InstallerVersion has breaking change when missing. - /// - InstallerVersionBehaviorChange, - - /// - /// Verb/@Target can't be converted. - /// - VerbTargetNotConvertable, - - /// - /// The bootstrapper application dll is now specified in its own element. - /// - BootstrapperApplicationDll, - - /// - /// The new bootstrapper application dll element is required. - /// - BootstrapperApplicationDllRequired, - - /// - /// bal:UseUILanguages is deprecated, 'true' is now the standard behavior. - /// - BalUseUILanguagesDeprecated, - - /// - /// The custom elements for built-in BAs are now required. - /// - BalBootstrapperApplicationRefToElement, - - /// - /// The ExePackage elements "XxxCommand" attributes have been renamed to "XxxArguments". - /// - RenameExePackageCommandToArguments, - - /// - /// The Win64 attribute has been renamed. Use the Bitness attribute instead. - /// - Win64AttributeRenamed, - - /// - /// Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute. - /// - Win64AttributeRenameCannotBeAutomatic, - - /// - /// The Tag element has been renamed. Use the element 'SoftwareTag' name. - /// - TagElementRenamed, - - /// - /// The Dependency namespace has been incorporated into WiX v4 namespace. - /// - IntegratedDependencyNamespace, - - /// - /// Remove unused namespaces. - /// - RemoveUnusedNamespaces, - - /// - /// The Remote element has been renamed. Use the "XxxPackagePayload" element instead. - /// - RemotePayloadRenamed, - - /// - /// The XxxPackage/@Name attribute must be specified on the child XxxPackagePayload element when using a remote payload. - /// - NameAttributeMovedToRemotePayload, - - /// - /// The XxxPackage/@Compressed attribute should not be specified when using a remote payload. - /// - CompressedAttributeUnnecessaryForRemotePayload, - - /// - /// The XxxPackage/@DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload. - /// - DownloadUrlAttributeMovedToRemotePayload, - - /// - /// The hash algorithm used for bundles changed from SHA1 to SHA512. - /// - BurnHashAlgorithmChanged, - - /// - /// CustomTable elements can't always be converted. - /// - CustomTableNotAlwaysConvertable, - - /// - /// CustomTable elements that don't contain the table definition are now CustomTableRef. - /// - CustomTableRef, - - /// - /// The RegistryKey element's Action attribute is obsolete. - /// - RegistryKeyActionObsolete, - - /// - /// The TagRef element has been renamed. Use the element 'SoftwareTagRef' name. - /// - TagRefElementRenamed, - - /// - /// The SoftwareTag element's Licensed attribute is obsolete. - /// - SoftwareTagLicensedObsolete, - - /// - /// The SoftwareTag element's Type attribute is obsolete. - /// - SoftwareTagTypeObsolete, - - /// - /// TARGETDIR directory should not longer be explicitly defined. - /// - TargetDirDeprecated, - - /// - /// Standard directories should no longer be defined using the Directory element. - /// - DefiningStandardDirectoryDeprecated, - - /// - /// Naked custom action and property references replaced with WixUtilExtension elements. - /// - UtilReferencesReplaced, - } - } -} diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj deleted file mode 100644 index 7dddefa5..00000000 --- a/src/WixToolset.Converters/WixToolset.Converters.csproj +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - netstandard2.0 - $(TargetFrameworks);net461;net472 - Converter - WiX Toolset Converters - embedded - true - true - - - - - - - - - - - diff --git a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs b/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs deleted file mode 100644 index 084d3b92..00000000 --- a/src/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs +++ /dev/null @@ -1,25 +0,0 @@ -// 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.Converters -{ - using WixToolset.Extensibility.Services; - - /// - /// Extension methods for adding Converters services. - /// - public static class WixToolsetCoreServiceProviderExtensions - { - /// - /// Adds Converters services. - /// - /// - /// - public static IWixToolsetCoreServiceProvider AddConverter(this IWixToolsetCoreServiceProvider coreProvider) - { - var extensionManager = coreProvider.GetService(); - extensionManager.Add(typeof(ConverterExtensionFactory).Assembly); - - return coreProvider; - } - } -} diff --git a/src/deps/wix.dll b/src/deps/wix.dll deleted file mode 100644 index 64f70f75..00000000 Binary files a/src/deps/wix.dll and /dev/null differ diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs b/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs deleted file mode 100644 index 01213524..00000000 --- a/src/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs +++ /dev/null @@ -1,606 +0,0 @@ -// 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 WixToolsetTest.Converters.Symbolizer -{ - using System; - using System.Collections.Generic; - using System.IO; - using System.Linq; - using WixBuildTools.TestSupport; - using Wix3 = Microsoft.Tools.WindowsInstallerXml; - using WixToolset.Converters.Symbolizer; - using WixToolset.Data; - using WixToolset.Data.WindowsInstaller; - using WixToolset.Data.Symbols; - using Xunit; - - public class ConvertSymbolsFixture - { - [Fact] - public void CanLoadWixoutAndConvertToIntermediate() - { - var rootFolder = TestData.Get(); - var dataFolder = TestData.Get(@"TestData\Integration"); - - using (var fs = new DisposableFileSystem()) - { - var intermediateFolder = fs.GetFolder(); - - var path = Path.Combine(dataFolder, "test.wixout"); - - var intermediate = ConvertSymbols.ConvertFile(path); - - Assert.NotNull(intermediate); - Assert.Single(intermediate.Sections); - Assert.Equal(String.Empty, intermediate.Id); - - // Save and load to guarantee round-tripping support. - // - var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); - intermediate.Save(wixiplFile); - - intermediate = Intermediate.Load(wixiplFile); - - var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); - var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); - - // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. - // - var tables = output.Tables.Cast(); - var wix3Dump = tables - .SelectMany(table => table.Rows.Cast() - .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) - .Where(s => !String.IsNullOrEmpty(s)) - .OrderBy(s => s) - .ToArray(); - - var symbols = intermediate.Sections.SelectMany(s => s.Symbols); - - var assemblySymbolsByFileId = symbols.OfType().ToDictionary(a => a.Id.Id); - - var wix4Dump = symbols - .SelectMany(symbol => SymbolToStrings(symbol, assemblySymbolsByFileId)) - .OrderBy(s => s) - .ToArray(); - -#if false - Assert.Equal(wix3Dump, wix4Dump); -#else // useful when you want to diff the outputs with another diff tool. - var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); - var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); - - var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); - var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); - - File.WriteAllText(path3, wix3TextDump); - File.WriteAllText(path4, wix4TextDump); - - Assert.Equal(wix3TextDump, wix4TextDump); -#endif - } - } - - private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) - { - var wixMediaByDiskId = new Dictionary(); - var wixMediaTable = output.Tables["WixMedia"]; - - if (wixMediaTable != null) - { - foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) - { - wixMediaByDiskId.Add((int)row[0], row); - } - } - - return wixMediaByDiskId; - } - - private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) - { - string fields = null; - - // Massage output to match WiX v3 rows and v4 symbols. - // - switch (row.Table.Name) - { - case "Directory": - var dirs = SplitDefaultDir((string)row[2]); - fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); - break; - case "File": - { - var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); - if (fieldValues[3] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[3] = "0"; - } - fields = String.Join(",", fieldValues); - break; - } - case "Media": - var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; - - fields = String.Join(",", row.Fields.Select(SafeConvertField)); - fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); - break; - case "RegLocator": - var type = (int)row[4]; - fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); - break; - case "RemoveFile": - var attributes = (int)row[4]; - var onInstall = (attributes & 1) == 1 ? (bool?)true : null; - var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; - fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); - fields = String.Join(",", fields, onInstall, onUninstall); - break; - case "Shortcut": - var split = ((string)row[2]).Split('|'); - var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); - fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); - break; - case "WixAction": - var table = (int)SequenceStringToSequenceTable(row[0]); - fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); - break; - case "WixFile": - { - var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); - if (fieldValues[8] == null) - { - // "Somebody" sometimes writes out a null field even when the column definition says - // it's non-nullable. Not naming names or anything. (SWID tags.) - fieldValues[8] = "0"; - } - if (fieldValues[10] == null) - { - // WixFile rows that come from merge modules will not have the attributes column set - // so initilaize with 0. - fieldValues[10] = "0"; - } - fields = String.Join(",", fieldValues); - break; - } - case "WixMedia": - break; - default: - fields = String.Join(",", row.Fields.Select(SafeConvertField)); - break; - } - - if (fields != null) - { - yield return $"{row.Table.Name}:{fields}"; - } - } - - private static IEnumerable SymbolToStrings(IntermediateSymbol symbol, Dictionary assemblySymbolsByFileId) - { - var name = symbol.Definition.Type == SymbolDefinitionType.SummaryInformation ? "_SummaryInformation" : symbol.Definition.Name; - var id = symbol.Id?.Id ?? String.Empty; - - string fields; - switch (symbol.Definition.Name) - { - // Massage output to match WiX v3 rows and v4 symbols. - // - case "Component": - { - var componentSymbol = (ComponentSymbol)symbol; - var attributes = ComponentLocation.Either == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; - attributes |= ComponentLocation.SourceOnly == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; - attributes |= ComponentKeyPathType.Registry == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; - attributes |= ComponentKeyPathType.OdbcDataSource == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; - attributes |= componentSymbol.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; - attributes |= componentSymbol.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; - attributes |= componentSymbol.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; - attributes |= componentSymbol.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; - attributes |= componentSymbol.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; - attributes |= componentSymbol.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; - attributes |= componentSymbol.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - attributes |= componentSymbol.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; - - fields = String.Join(",", - componentSymbol.ComponentId, - componentSymbol.DirectoryRef, - attributes.ToString(), - componentSymbol.Condition, - componentSymbol.KeyPath - ); - break; - } - case "CustomAction": - { - var customActionSymbol = (CustomActionSymbol)symbol; - var type = customActionSymbol.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; - type |= customActionSymbol.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; - type |= customActionSymbol.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; - type |= customActionSymbol.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; - type |= customActionSymbol.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; - type |= customActionSymbol.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; - type |= CustomActionExecutionType.FirstSequence == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; - type |= CustomActionExecutionType.OncePerProcess == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; - type |= CustomActionExecutionType.ClientRepeat == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; - type |= CustomActionExecutionType.Deferred == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; - type |= CustomActionExecutionType.Rollback == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; - type |= CustomActionExecutionType.Commit == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; - type |= CustomActionSourceType.File == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; - type |= CustomActionSourceType.Directory == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; - type |= CustomActionSourceType.Property == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; - type |= CustomActionTargetType.Dll == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; - type |= CustomActionTargetType.Exe == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; - type |= CustomActionTargetType.TextData == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; - type |= CustomActionTargetType.JScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; - type |= CustomActionTargetType.VBScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; - - fields = String.Join(",", - type.ToString(), - customActionSymbol.Source, - customActionSymbol.Target, - customActionSymbol.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null - ); - break; - } - case "Directory": - { - var directorySymbol = (DirectorySymbol)symbol; - - if (!String.IsNullOrEmpty(directorySymbol.ComponentGuidGenerationSeed)) - { - yield return $"WixDirectory:{directorySymbol.Id.Id},{directorySymbol.ComponentGuidGenerationSeed}"; - } - - fields = String.Join(",", directorySymbol.ParentDirectoryRef, directorySymbol.Name, directorySymbol.ShortName, directorySymbol.SourceName, directorySymbol.SourceShortName); - break; - } - case "Feature": - { - var featureSymbol = (FeatureSymbol)symbol; - var attributes = featureSymbol.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; - attributes |= featureSymbol.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; - attributes |= FeatureInstallDefault.FollowParent == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; - attributes |= FeatureInstallDefault.Source == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; - attributes |= FeatureTypicalDefault.Advertise == featureSymbol.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; - - fields = String.Join(",", - featureSymbol.ParentFeatureRef, - featureSymbol.Title, - featureSymbol.Description, - featureSymbol.Display.ToString(), - featureSymbol.Level.ToString(), - featureSymbol.DirectoryRef, - attributes.ToString()); - break; - } - case "File": - { - var fileSymbol = (FileSymbol)symbol; - - if (fileSymbol.BindPath != null) - { - yield return $"BindImage:{fileSymbol.Id.Id},{fileSymbol.BindPath}"; - } - - if (fileSymbol.FontTitle != null) - { - yield return $"Font:{fileSymbol.Id.Id},{fileSymbol.FontTitle}"; - } - - if (fileSymbol.SelfRegCost.HasValue) - { - yield return $"SelfReg:{fileSymbol.Id.Id},{fileSymbol.SelfRegCost}"; - } - - int? assemblyAttributes = null; - if (assemblySymbolsByFileId.TryGetValue(fileSymbol.Id.Id, out var assemblySymbol)) - { - if (assemblySymbol.Type == AssemblyType.DotNetAssembly) - { - assemblyAttributes = 0; - } - else if (assemblySymbol.Type == AssemblyType.Win32Assembly) - { - assemblyAttributes = 1; - } - } - - yield return "WixFile:" + String.Join(",", - fileSymbol.Id.Id, - assemblyAttributes, - assemblySymbol?.ManifestFileRef, - assemblySymbol?.ApplicationFileRef, - fileSymbol.DirectoryRef, - fileSymbol.DiskId, - fileSymbol.Source.Path, - null, // assembly processor arch - fileSymbol.PatchGroup, - 0, - (int)fileSymbol.PatchAttributes, - fileSymbol.RetainLengths, - fileSymbol.IgnoreOffsets, - fileSymbol.IgnoreLengths, - fileSymbol.RetainOffsets - ); - - var fileAttributes = 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; - fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; - - fields = String.Join(",", - fileSymbol.ComponentRef, - fileSymbol.Name, - fileSymbol.FileSize.ToString(), - fileSymbol.Version, - fileSymbol.Language, - fileAttributes); - break; - } - - case "Media": - fields = String.Join(",", symbol.Fields.Skip(1).Select(SafeConvertField)); - break; - - case "Assembly": - { - var assemblySymbol = (AssemblySymbol)symbol; - - id = null; - name = "MsiAssembly"; - fields = String.Join(",", assemblySymbol.ComponentRef, assemblySymbol.FeatureRef, assemblySymbol.ManifestFileRef, assemblySymbol.ApplicationFileRef, assemblySymbol.Type == AssemblyType.Win32Assembly ? 1 : 0); - break; - } - case "RegLocator": - { - var locatorSymbol = (RegLocatorSymbol)symbol; - - fields = String.Join(",", (int)locatorSymbol.Root, locatorSymbol.Key, locatorSymbol.Name, (int)locatorSymbol.Type, locatorSymbol.Win64); - break; - } - case "Registry": - { - var registrySymbol = (RegistrySymbol)symbol; - var value = registrySymbol.Value; - - switch (registrySymbol.ValueType) - { - case RegistryValueType.Binary: - value = String.Concat("#x", value); - break; - case RegistryValueType.Expandable: - value = String.Concat("#%", value); - break; - case RegistryValueType.Integer: - value = String.Concat("#", value); - break; - case RegistryValueType.MultiString: - switch (registrySymbol.ValueAction) - { - case RegistryValueActionType.Append: - value = String.Concat("[~]", value); - break; - case RegistryValueActionType.Prepend: - value = String.Concat(value, "[~]"); - break; - case RegistryValueActionType.Write: - default: - if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) - { - value = String.Concat("[~]", value, "[~]"); - } - break; - } - break; - case RegistryValueType.String: - // escape the leading '#' character for string registry keys - if (null != value && value.StartsWith("#", StringComparison.Ordinal)) - { - value = String.Concat("#", value); - } - break; - } - - fields = String.Join(",", - ((int)registrySymbol.Root).ToString(), - registrySymbol.Key, - registrySymbol.Name, - value, - registrySymbol.ComponentRef - ); - break; - } - - case "RemoveRegistry": - { - var removeRegistrySymbol = (RemoveRegistrySymbol)symbol; - fields = String.Join(",", - ((int)removeRegistrySymbol.Root).ToString(), - removeRegistrySymbol.Key, - removeRegistrySymbol.Name, - removeRegistrySymbol.ComponentRef - ); - break; - } - - case "ServiceControl": - { - var serviceControlSymbol = (ServiceControlSymbol)symbol; - - var events = serviceControlSymbol.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; - events |= serviceControlSymbol.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; - events |= serviceControlSymbol.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; - events |= serviceControlSymbol.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; - events |= serviceControlSymbol.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; - events |= serviceControlSymbol.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; - - fields = String.Join(",", - serviceControlSymbol.Name, - events.ToString(), - serviceControlSymbol.Arguments, - serviceControlSymbol.Wait == true ? "1" : "0", - serviceControlSymbol.ComponentRef - ); - break; - } - - case "ServiceInstall": - { - var serviceInstallSymbol = (ServiceInstallSymbol)symbol; - - var errorControl = (int)serviceInstallSymbol.ErrorControl; - errorControl |= serviceInstallSymbol.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; - - var serviceType = (int)serviceInstallSymbol.ServiceType; - serviceType |= serviceInstallSymbol.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; - - fields = String.Join(",", - serviceInstallSymbol.Name, - serviceInstallSymbol.DisplayName, - serviceType.ToString(), - ((int)serviceInstallSymbol.StartType).ToString(), - errorControl.ToString(), - serviceInstallSymbol.LoadOrderGroup, - serviceInstallSymbol.Dependencies, - serviceInstallSymbol.StartName, - serviceInstallSymbol.Password, - serviceInstallSymbol.Arguments, - serviceInstallSymbol.ComponentRef, - serviceInstallSymbol.Description - ); - break; - } - - case "Upgrade": - { - var upgradeSymbol = (UpgradeSymbol)symbol; - - var attributes = upgradeSymbol.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; - attributes |= upgradeSymbol.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; - attributes |= upgradeSymbol.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; - attributes |= upgradeSymbol.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; - attributes |= upgradeSymbol.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; - attributes |= upgradeSymbol.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; - - fields = String.Join(",", - upgradeSymbol.VersionMin, - upgradeSymbol.VersionMax, - upgradeSymbol.Language, - attributes.ToString(), - upgradeSymbol.Remove, - upgradeSymbol.ActionProperty - ); - break; - } - - case "WixAction": - { - var wixActionSymbol = (WixActionSymbol)symbol; - var data = wixActionSymbol.Fields[(int)WixActionSymbolFields.SequenceTable].AsObject(); - var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionSymbol.SequenceTable; - - fields = String.Join(",", - sequenceTableAsInt, - wixActionSymbol.Action, - wixActionSymbol.Condition, - wixActionSymbol.Sequence?.ToString() ?? String.Empty, - wixActionSymbol.Before, - wixActionSymbol.After, - wixActionSymbol.Overridable == true ? "1" : "0" - ); - break; - } - - case "WixComplexReference": - { - var wixComplexReferenceSymbol = (WixComplexReferenceSymbol)symbol; - fields = String.Join(",", - wixComplexReferenceSymbol.Parent, - (int)wixComplexReferenceSymbol.ParentType, - wixComplexReferenceSymbol.ParentLanguage, - wixComplexReferenceSymbol.Child, - (int)wixComplexReferenceSymbol.ChildType, - wixComplexReferenceSymbol.IsPrimary ? "1" : "0" - ); - break; - } - - case "WixProperty": - { - var wixPropertySymbol = (WixPropertySymbol)symbol; - var attributes = wixPropertySymbol.Admin ? 0x1 : 0; - attributes |= wixPropertySymbol.Hidden ? 0x2 : 0; - attributes |= wixPropertySymbol.Secure ? 0x4 : 0; - - fields = String.Join(",", - wixPropertySymbol.PropertyRef, - attributes.ToString() - ); - break; - } - - default: - fields = String.Join(",", symbol.Fields.Select(SafeConvertField)); - break; - } - - fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; - yield return $"{name}:{fields}"; - } - - private static SequenceTable SequenceStringToSequenceTable(object sequenceString) - { - switch (sequenceString) - { - case "AdminExecuteSequence": - return SequenceTable.AdminExecuteSequence; - case "AdminUISequence": - return SequenceTable.AdminUISequence; - case "AdvtExecuteSequence": - return SequenceTable.AdvertiseExecuteSequence; - case "InstallExecuteSequence": - return SequenceTable.InstallExecuteSequence; - case "InstallUISequence": - return SequenceTable.InstallUISequence; - default: - throw new ArgumentException($"Unknown sequence: {sequenceString}"); - } - } - - private static string SafeConvertField(Wix3.Field field) - { - return field?.Data?.ToString(); - } - - private static string SafeConvertField(IntermediateField field) - { - var data = field.AsObject(); - if (data is IntermediateFieldPathValue path) - { - return path.Path; - } - - return data?.ToString(); - } - - private static string[] SplitDefaultDir(string defaultDir) - { - var split1 = defaultDir.Split(':'); - var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); - var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; - return new[] - { - targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], - targetSplit.Length > 1 ? targetSplit[0] : String.Empty, - sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], - sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty - }; - } - } -} diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout deleted file mode 100644 index da64b8af..00000000 Binary files a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout and /dev/null differ diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj deleted file mode 100644 index d7c4e625..00000000 --- a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj +++ /dev/null @@ -1,47 +0,0 @@ - - - - Debug - x86 - 3.10 - d59f1c1e-9238-49fa-bfa2-ec1d9c2dda1d - 2.0 - SymbolizerWixout - Package - - - bin\$(Configuration)\ - obj\$(Configuration)\ - Debug - - - bin\$(Configuration)\ - obj\$(Configuration)\ - - - - - - - $(WixExtDir)\WixUtilExtension.dll - WixUtilExtension - - - $(WixExtDir)\WixNetFxExtension.dll - WixNetFxExtension - - - - - - - - - \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs b/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs deleted file mode 100644 index 46d4fb43..00000000 --- a/src/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj deleted file mode 100644 index 995d9297..00000000 --- a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - net461 - false - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject b/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject deleted file mode 100644 index 18ab4f79..00000000 --- a/src/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject +++ /dev/null @@ -1,9 +0,0 @@ - - - - - WixToolsetTest.Converters.Symbolizer.ConvertSymbolsFixture.CanLoadWixoutAndConvertToIntermediate - - - - \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs b/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs deleted file mode 100644 index 2421d73b..00000000 --- a/src/test/WixToolsetTest.Converters/BaseConverterFixture.cs +++ /dev/null @@ -1,33 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.IO; - using System.Text; - using System.Xml; - using System.Xml.Linq; - using Xunit; - - public abstract class BaseConverterFixture - { - protected static string UnformattedDocumentString(XDocument document, bool omitXmlDeclaration = true) - { - var sb = new StringBuilder(); - - using (var writer = new StringWriter(sb)) - using (var xml = XmlWriter.Create(writer, new XmlWriterSettings { OmitXmlDeclaration = omitXmlDeclaration })) - { - document.Save(xml); - } - - return sb.ToString().TrimStart(); - } - - protected static string[] UnformattedDocumentLines(XDocument document, bool omitXmlDeclaration = true) - { - var unformatted = UnformattedDocumentString(document, omitXmlDeclaration); - return unformatted.Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/BitnessFixture.cs b/src/test/WixToolsetTest.Converters/BitnessFixture.cs deleted file mode 100644 index e45a9388..00000000 --- a/src/test/WixToolsetTest.Converters/BitnessFixture.cs +++ /dev/null @@ -1,187 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class BitnessFixture : BaseConverterFixture - { - [Fact] - public void FixComponentBitness() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(10, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixRegistrySearchBitness() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixUtilRegistrySearchBitness() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(6, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixApprovedExeBitness() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs deleted file mode 100644 index 158ab3be..00000000 --- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs +++ /dev/null @@ -1,418 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class BootstrapperApplicationFixture : BaseConverterFixture - { - [Fact] - public void CantCreateBootstrapperApplicationDllFromV3PayloadGroupRef() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(2, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void ConvertDotNetCoreBootstrapperApplicationRefWithExistingElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(1, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void ConvertDotNetCoreBootstrapperApplicationRefWithoutExistingElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - "", - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(1, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void ConvertFrameworkBootstrapperApplicationRefWithExistingElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void ConvertFrameworkBootstrapperApplicationRefWithoutExistingElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - "", - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void ConvertStandardBootstrapperApplicationRefWithExistingElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void ConvertStandardBootstrapperApplicationRefWithoutExistingElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - "", - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void CreateBootstrapperApplicationDllFromV3() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - "", - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void CreateBootstrapperApplicationDllFromV3Payload() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - "", - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void DoesntSetDpiUnawareFromV4() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(0, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void KeepsDpiAwarenessFromV4() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - "", - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(1, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void RemovesBalUseUILanguages() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/test/WixToolsetTest.Converters/ConditionFixture.cs deleted file mode 100644 index d3f65aeb..00000000 --- a/src/test/WixToolsetTest.Converters/ConditionFixture.cs +++ /dev/null @@ -1,297 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class ConditionFixture : BaseConverterFixture - { - [Fact] - public void FixControlCondition() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " x=y", - " a<>b", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixPublishCondition() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " 1<2", - " 1", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixComponentCondition() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " 1<2", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixFeatureCondition() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " PROP = 1", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixLaunchCondition() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " 1<2", - " ", - " ", - " 1=2", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixLaunchConditionInProduct() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " 1<2", - " ", - " ", - " 1=2", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(6, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixPermissionExCondition() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " 1<2", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs deleted file mode 100644 index 13df9da7..00000000 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ /dev/null @@ -1,449 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class ConverterFixture : BaseConverterFixture - { - private static readonly XNamespace Wix4Namespace = "http://wixtoolset.org/schemas/v4/wxs"; - - [Fact] - public void EnsuresNoDeclaration() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void EnsuresDeclarationWhenIgnored() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, ignoreErrors: new[] { "DeclarationPresent" } ); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document, omitXmlDeclaration: false); - - Assert.Equal(0, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertMainNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - //Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertNamedMainNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); - } - - [Fact] - public void CanConvertNonWixDefaultNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(3, errors); - Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); - Assert.Equal("http://wixtoolset.org/schemas/v4/wxs/util", document.Root.GetDefaultNamespace()); - } - - [Fact] - public void CanRemoveUnusedNamespaces() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(4, errors); - Assert.Equal(expected, actual); - Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); - } - - [Fact] - public void CanConvertMissingWixNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); - } - - [Fact] - public void CanConvertMissingIncludeNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); - } - - [Fact] - public void CanConvertAnonymousFile() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(3, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertShortNameDirectoryWithoutName() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertCatalogElement() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertSuppressSignatureValidationNo() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertSuppressSignatureValidationYes() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CantConvertVerbTarget() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertDeprecatedPrefix() - { - var parse = String.Join(Environment.NewLine, - "", - "", - "", - "", - "", - "", - "", - "", - ""); - - var expected = String.Join(Environment.NewLine, - "", - "", - "", - "", - "", - "", - "", - "", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(3, errors); - Assert.Equal(expected, actual); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs deleted file mode 100644 index a39f6243..00000000 --- a/src/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs +++ /dev/null @@ -1,195 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.IO; - using System.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolset.Core; - using WixToolset.Core.TestPackage; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class ConverterIntegrationFixture - { - [Fact] - public void CanConvertPermissionExFile() - { - const string beforeFileName = "v3.wxs"; - const string afterFileName = "v4_expected.wxs"; - var folder = TestData.Get(@"TestData\PermissionEx"); - - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(true); - var targetFile = Path.Combine(baseFolder, beforeFileName); - File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4); - var errors = converter.ConvertFile(targetFile, true); - - Assert.Equal(8, errors); - - var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); - var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); - Assert.Equal(expected, actual); - - EnsureFixed(targetFile); - } - } - - [Fact] - public void CanConvertSingleFile() - { - const string beforeFileName = "SingleFile.wxs"; - const string afterFileName = "ConvertedSingleFile.wxs"; - var folder = TestData.Get(@"TestData\SingleFile"); - - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(true); - var targetFile = Path.Combine(baseFolder, beforeFileName); - File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4); - var errors = converter.ConvertFile(targetFile, true); - - Assert.Equal(9, errors); - - var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); - var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); - Assert.Equal(expected, actual); - - EnsureFixed(targetFile); - } - } - - [Fact] - public void CanDetectReadOnlyOutputFile() - { - const string beforeFileName = "SingleFile.wxs"; - var folder = TestData.Get(@"TestData\SingleFile"); - - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(true); - var targetFile = Path.Combine(baseFolder, beforeFileName); - File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); - - var info = new FileInfo(targetFile); - info.IsReadOnly = true; - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4); - var errors = converter.ConvertFile(targetFile, true); - - Assert.Single(messaging.Messages.Where(m => m.Id == 5/*WixConverter.ConverterTestType.UnauthorizedAccessException*/)); - } - } - - [Fact] - public void RetainsPreprocessorInstructions() - { - const string beforeFileName = "Preprocessor.wxs"; - const string afterFileName = "ConvertedPreprocessor.wxs"; - var folder = TestData.Get(@"TestData\Preprocessor"); - - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(true); - var targetFile = Path.Combine(baseFolder, beforeFileName); - File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); - - var settingsFile = Path.Combine(folder, "wixcop.settings.xml"); - - var result = RunConversion(targetFile, settingsFile: settingsFile); - Assert.Equal(9, result.ExitCode); - - var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); - var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); - Assert.Equal(expected, actual); - - EnsureFixed(targetFile); - } - } - - [Fact] - public void CanConvertQtExec() - { - const string beforeFileName = "v3.wxs"; - const string afterFileName = "v4_expected.wxs"; - var folder = TestData.Get(@"TestData\QtExec"); - - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(true); - var targetFile = Path.Combine(baseFolder, beforeFileName); - File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); - - var result = RunConversion(targetFile); - Assert.Equal(13, result.ExitCode); - - var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); - var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); - Assert.Equal(expected, actual); - - EnsureFixed(targetFile); - } - } - - [Fact] - public void DetectUnconvertableQtExecCmdTimeout() - { - const string beforeFileName = "v3.wxs"; - const string afterFileName = "v4_expected.wxs"; - var folder = TestData.Get(@"TestData\QtExec.bad"); - - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(true); - var targetFile = Path.Combine(baseFolder, beforeFileName); - File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); - - var result = RunConversion(targetFile); - - Assert.Equal(13, result.ExitCode); - Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); - - var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); - var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); - Assert.Equal(expected, actual); - - // still fails because QtExecCmdTimeoutAmbiguous is unfixable - var result2 = RunConversion(targetFile); - Assert.Equal(1, result2.ExitCode); - } - } - - private static WixRunnerResult RunConversion(string targetFile, bool fixErrors = true, string settingsFile = null) - { - var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider().AddConverter(); - - var exitCode = WixRunner.Execute(new[] - { - "convert", - fixErrors ? null : "--dry-run", - String.IsNullOrEmpty(settingsFile) ? null : "-set1" + settingsFile, - targetFile - }, serviceProvider, out var messages); - - return new WixRunnerResult { ExitCode = exitCode.Result, Messages = messages.ToArray() }; - } - - private static void EnsureFixed(string targetFile) - { - var messaging2 = new MockMessaging(); - var converter2 = new WixConverter(messaging2, 4); - var errors2 = converter2.ConvertFile(targetFile, true); - Assert.Equal(0, errors2); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/test/WixToolsetTest.Converters/CustomActionFixture.cs deleted file mode 100644 index eafc171a..00000000 --- a/src/test/WixToolsetTest.Converters/CustomActionFixture.cs +++ /dev/null @@ -1,88 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.IO; - using System.Xml.Linq; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class CustomActionFixture : BaseConverterFixture - { - [Fact] - public void CanConvertCustomAction() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(11, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertCustomActionScript() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " function() {", - " var x = 0;", - " return x;", - " }", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expectedScript = String.Join("\n", - "function() {", - " var x = 0;", - " return x;", - " }"); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - - var script = File.ReadAllText("Foo.js"); - Assert.Equal(expectedScript, script); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/test/WixToolsetTest.Converters/CustomTableFixture.cs deleted file mode 100644 index 2b81a863..00000000 --- a/src/test/WixToolsetTest.Converters/CustomTableFixture.cs +++ /dev/null @@ -1,363 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class CustomTableFixture : BaseConverterFixture - { - [Fact] - public void FixCustomTableCategoryAndModularization() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixCustomRowTextValue() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " Some value", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixCustomRowCdataValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixCustomRowWithoutValue() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void CanConvertBundleCustomTableBootstrapperApplicationData() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " Row1", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Bundle); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertBundleCustomTableRef() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " Row1", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Bundle); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertMsiCustomTableBootstrapperApplicationData() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " Row1", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Msi); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanConvertMsiCustomTableRef() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " Row1", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Msi); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(2, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanDetectAmbiguousCustomTableBootstrapperApplicationData() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - - [Fact] - public void CanRemoveBootstrapperApplicationDataFromRealCustomTable() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(1, errors); - Assert.Equal(expected, actual); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/DependencyFixture.cs b/src/test/WixToolsetTest.Converters/DependencyFixture.cs deleted file mode 100644 index 41ded927..00000000 --- a/src/test/WixToolsetTest.Converters/DependencyFixture.cs +++ /dev/null @@ -1,178 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class DependencyFixture : BaseConverterFixture - { - [Fact] - public void FixPackageDependencyProvides() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixPackageDependencyRequires() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(7, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixPackageDependencyRequiresRef() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(7, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixBundleDependencyProvides() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/DirectoryFixture.cs b/src/test/WixToolsetTest.Converters/DirectoryFixture.cs deleted file mode 100644 index 3c906320..00000000 --- a/src/test/WixToolsetTest.Converters/DirectoryFixture.cs +++ /dev/null @@ -1,92 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class DirectoryFixture : BaseConverterFixture - { - [Fact] - public void RemoveTargetDir() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixStandardDirectory() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/ExePackageFixture.cs b/src/test/WixToolsetTest.Converters/ExePackageFixture.cs deleted file mode 100644 index 0ee8d065..00000000 --- a/src/test/WixToolsetTest.Converters/ExePackageFixture.cs +++ /dev/null @@ -1,49 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class ExePackageFixture : BaseConverterFixture - { - [Fact] - public void CanConvertExePackageCommandToArguments() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/FeatureFixture.cs b/src/test/WixToolsetTest.Converters/FeatureFixture.cs deleted file mode 100644 index 1df94a81..00000000 --- a/src/test/WixToolsetTest.Converters/FeatureFixture.cs +++ /dev/null @@ -1,110 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class FeatureFixture : BaseConverterFixture - { - [Fact] - public void FixAllowAttributes() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixDisallowAttributes() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void RemoveDeprecatedAllowAdvertiseAttributes() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs deleted file mode 100644 index a101019b..00000000 --- a/src/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs +++ /dev/null @@ -1,47 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class FirewallExtensionFixture : BaseConverterFixture - { - [Fact] - public void FixRemoteAddressValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " 127.0.0.1", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/FormatFixture.cs b/src/test/WixToolsetTest.Converters/FormatFixture.cs deleted file mode 100644 index 739fba66..00000000 --- a/src/test/WixToolsetTest.Converters/FormatFixture.cs +++ /dev/null @@ -1,117 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class FormatFixture : BaseConverterFixture - { - [Fact] - public void CanFixWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4, null, null); - - var errors = converter.FormatDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(5, errors); - } - - [Fact] - public void CanPreserveNewLines() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - "", - " ", - "", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - "", - " ", - "", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4, null, null); - - var conversions = converter.FormatDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(4, conversions); - } - - [Fact] - public void CanFormatWithNewLineAtEndOfFile() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - "", - " ", - "", - " ", - "", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - "", - " ", - "", - " ", - "", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 4, null, null); - - var conversions = converter.FormatDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(3, conversions); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/IncludeFixture.cs b/src/test/WixToolsetTest.Converters/IncludeFixture.cs deleted file mode 100644 index 2fd8244f..00000000 --- a/src/test/WixToolsetTest.Converters/IncludeFixture.cs +++ /dev/null @@ -1,68 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class IncludeFixture : BaseConverterFixture - { - [Fact] - public void EnsureNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = new[] - { - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(1, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixNamespace() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - ""); - - var expected = new[] - { - "", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(1, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs b/src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs deleted file mode 100644 index b6bb8a40..00000000 --- a/src/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs +++ /dev/null @@ -1,51 +0,0 @@ -// 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 WixToolsetTest.Converters.Mocks -{ - using System; - using System.Collections.Generic; - using WixToolset.Extensibility.Services; - - public class MockCoreServiceProvider : IWixToolsetCoreServiceProvider - { - public Dictionary, object>> CreationFunctions { get; } = new Dictionary, object>>(); - - public Dictionary Singletons { get; } = new Dictionary() - { - { typeof(IMessaging), new MockMessaging() } - }; - - public void AddService(Type serviceType, Func, object> creationFunction) => this.CreationFunctions.Add(serviceType, creationFunction); - - public void AddService(Func, T> creationFunction) where T : class => this.AddService(typeof(T), creationFunction); - - public T GetService() where T : class => this.TryGetService(typeof(T), out var obj) ? (T)obj : null; - - public object GetService(Type serviceType) => this.TryGetService(serviceType, out var service) ? service : null; - - public bool TryGetService(Type serviceType, out object service) - { - if (!this.Singletons.TryGetValue(serviceType, out service)) - { - if (this.CreationFunctions.TryGetValue(serviceType, out var creationFunction)) - { - service = creationFunction(this, this.Singletons); - } - } - - return service != null; - } - - public bool TryGetService(out T service) where T : class - { - service = null; - - if (this.TryGetService(typeof(T), out var obj)) - { - service = (T)obj; - } - - return service != null; - } - } -} \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs b/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs deleted file mode 100644 index 77821a1c..00000000 --- a/src/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs +++ /dev/null @@ -1,39 +0,0 @@ -// 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 WixToolsetTest.Converters.Mocks -{ - using System; - using System.Collections.Generic; - using WixToolset.Data; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Services; - - public class MockMessaging : IMessaging - { - public List Messages { get; } = new List(); - - public bool EncounteredError { get; private set; } - - public int LastErrorNumber { get; } - - public bool ShowVerboseMessages { get; set; } - - public bool SuppressAllWarnings { get; set; } - - public bool WarningsAsError { get; set; } - - public void ElevateWarningMessage(int warningNumber) => throw new NotImplementedException(); - - public void SetListener(IMessageListener listener) => throw new NotImplementedException(); - - public void SuppressWarningMessage(int warningNumber) => throw new NotImplementedException(); - - public void Write(Message message) - { - this.Messages.Add(message); - this.EncounteredError |= message.Level == MessageLevel.Error; - } - - public void Write(string message, bool verbose = false) => throw new NotImplementedException(); - } -} diff --git a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs b/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs deleted file mode 100644 index e01b9789..00000000 --- a/src/test/WixToolsetTest.Converters/ProductPackageFixture.cs +++ /dev/null @@ -1,278 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.IO; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolset.Core.TestPackage; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class ProductPackageFixture : BaseConverterFixture - { - [Fact] - public void FixesCompressedWhenYes() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 4, expected); - } - - [Fact] - public void FixesCompressedWhenNo() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 4, expected); - } - - [Fact] - public void FixesCompressedWhenOmitted() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 4, expected); - } - - private static void AssertSuccess(string input, int expectedErrorCount, string[] expected) - { - var document = XDocument.Parse(input, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(expectedErrorCount, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixesInstallerVersion() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 3, expected); - } - - [Fact] - public void FixesDefaultInstallerVersion() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 3, expected); - } - - [Fact] - public void FixesImplicitInstallerVersion() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 4, expected); - } - - [Fact] - public void FixesNonDefaultInstallerVersion() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 3, expected); - } - - [Fact] - public void FixesLimitedInstallerPrivileges() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 4, expected); - } - - [Fact] - public void FixesElevatedInstallerPrivileges() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - "" - }; - - AssertSuccess(parse, 4, expected); - } - - [Fact] - public void CanDecompileAndRecompile() - { - using (var fs = new DisposableFileSystem()) - { - var baseFolder = fs.GetFolder(); - var intermediateFolder = Path.Combine(baseFolder, "obj"); - var decompiledWxsPath = Path.Combine(baseFolder, "TypicalV3.wxs"); - - var folder = TestData.Get(@"TestData\PackageSummaryInformation"); - var v3msiPath = Path.Combine(folder, "TypicalV3.msi"); - var result = WixRunner.Execute(new[] - { - "decompile", v3msiPath, - "-intermediateFolder", intermediateFolder, - "-o", decompiledWxsPath - }); - - result.AssertSuccess(); - - var v4msiPath = Path.Combine(intermediateFolder, "TypicalV4.msi"); - result = WixRunner.Execute(new[] - { - "build", decompiledWxsPath, - "-arch", "x64", - "-intermediateFolder", intermediateFolder, - "-o", v4msiPath - }); - - result.AssertSuccess(); - - Assert.True(File.Exists(v4msiPath)); - - var v3results = Query.QueryDatabase(v3msiPath, new[] { "_SummaryInformation", "Property" }); - var v4results = Query.QueryDatabase(v4msiPath, new[] { "_SummaryInformation", "Property" }); - WixAssert.CompareLineByLine(v3results, v4results); - } - } - } -} diff --git a/src/test/WixToolsetTest.Converters/PropertyFixture.cs b/src/test/WixToolsetTest.Converters/PropertyFixture.cs deleted file mode 100644 index e50a6518..00000000 --- a/src/test/WixToolsetTest.Converters/PropertyFixture.cs +++ /dev/null @@ -1,108 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class PropertyFixture : BaseConverterFixture - { - [Fact] - public void CanFixCdataWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(1, errors); - } - - [Fact] - public void CanFixCdataWithWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(1, errors); - } - - [Fact] - public void CanKeepCdataWithOnlyWhitespace() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - var errors = converter.ConvertDocument(document); - - var actual = UnformattedDocumentString(document); - - Assert.Equal(expected, actual); - Assert.Equal(1, errors); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/RegistryFixture.cs b/src/test/WixToolsetTest.Converters/RegistryFixture.cs deleted file mode 100644 index 405f5416..00000000 --- a/src/test/WixToolsetTest.Converters/RegistryFixture.cs +++ /dev/null @@ -1,54 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class RegistryFixture : BaseConverterFixture - { - [Fact] - public void FixRegistryKeyAction() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs b/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs deleted file mode 100644 index b2640e13..00000000 --- a/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs +++ /dev/null @@ -1,104 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class RemotePayloadFixture : BaseConverterFixture - { - [Fact] - public void CanConvertExePackageRemotePayload() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(6, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void CanConvertMsuPackageRemotePayload() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(5, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/SequenceFixture.cs b/src/test/WixToolsetTest.Converters/SequenceFixture.cs deleted file mode 100644 index ec6c709b..00000000 --- a/src/test/WixToolsetTest.Converters/SequenceFixture.cs +++ /dev/null @@ -1,49 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class SequenceFixture : BaseConverterFixture - { - [Fact] - public void FixCondition() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " NOT Installed", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(2, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/TagFixture.cs b/src/test/WixToolsetTest.Converters/TagFixture.cs deleted file mode 100644 index 5e07c83b..00000000 --- a/src/test/WixToolsetTest.Converters/TagFixture.cs +++ /dev/null @@ -1,111 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class TagFixture : BaseConverterFixture - { - [Fact] - public void FixTagExtension() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixTagExtensionDeprecations() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(7, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixTagExtensionTagRef() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi b/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi deleted file mode 100644 index 0d7e1b21..00000000 Binary files a/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi and /dev/null differ diff --git a/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs b/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs deleted file mode 100644 index 8c5027b4..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs deleted file mode 100644 index 9a739052..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs deleted file mode 100644 index 6bf3c1ea..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs deleted file mode 100644 index 8188d900..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs deleted file mode 100644 index 2eb908c2..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml b/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml deleted file mode 100644 index 9d3ad496..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs deleted file mode 100644 index b0fcf9c9..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs deleted file mode 100644 index 95d2f618..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs deleted file mode 100644 index 8d81a758..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs deleted file mode 100644 index f24d3f8f..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs deleted file mode 100644 index 5bcdaf59..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs b/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs deleted file mode 100644 index 310ae811..00000000 --- a/src/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs b/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs deleted file mode 100644 index 10450c68..00000000 --- a/src/test/WixToolsetTest.Converters/UtilExtensionFixture.cs +++ /dev/null @@ -1,190 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class UtilExtensionFixture : BaseConverterFixture - { - [Fact] - public void FixCloseAppsCondition() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " a<>b", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixXmlConfigValue() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " a<>b", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void WarnsOnAllRegistryValueSearches() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - - [Fact] - public void FixXmlConfigValueCData() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " b]]>", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void FixQueryOsPropertyRefs() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(6, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/VariableFixture.cs b/src/test/WixToolsetTest.Converters/VariableFixture.cs deleted file mode 100644 index b7b7388f..00000000 --- a/src/test/WixToolsetTest.Converters/VariableFixture.cs +++ /dev/null @@ -1,86 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class VariableFixture : BaseConverterFixture - { - [Fact] - public void FixFormattedType() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(3, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - - [Fact] - public void DoesntFixFormattedTypeFromV4() - { - var parse = String.Join(Environment.NewLine, - "", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(0, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs b/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs deleted file mode 100644 index 16a68895..00000000 --- a/src/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs +++ /dev/null @@ -1,54 +0,0 @@ -// 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 WixToolsetTest.Converters -{ - using System; - using System.Xml.Linq; - using WixBuildTools.TestSupport; - using WixToolset.Converters; - using WixToolsetTest.Converters.Mocks; - using Xunit; - - public class Wix4ConversionFixture : BaseConverterFixture - { - [Fact] - public void DoesNotAddFileId() - { - var parse = String.Join(Environment.NewLine, - "", - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - ""); - - var expected = new[] - { - "", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "" - }; - - var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); - - var messaging = new MockMessaging(); - var converter = new WixConverter(messaging, 2, null, null); - - var errors = converter.ConvertDocument(document); - Assert.Equal(1, errors); - - var actualLines = UnformattedDocumentLines(document); - WixAssert.CompareLineByLine(expected, actualLines); - } - } -} diff --git a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj deleted file mode 100644 index 29b02b95..00000000 --- a/src/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - netcoreapp3.1 - false - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/version.json b/src/version.json new file mode 100644 index 00000000..5f857771 --- /dev/null +++ b/src/version.json @@ -0,0 +1,11 @@ +{ + "version": "4.0", + "publicReleaseRefSpec": [ + "^refs/heads/master$" + ], + "cloudBuild": { + "buildNumber": { + "enabled": true + } + } +} diff --git a/src/wix/Directory.Build.props b/src/wix/Directory.Build.props new file mode 100644 index 00000000..b3c6287c --- /dev/null +++ b/src/wix/Directory.Build.props @@ -0,0 +1,27 @@ + + + + + + Debug + false + MSB3246 + + $(MSBuildProjectName) + $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)..\build\)) + $(BaseOutputPath)obj\$(ProjectName)\ + $(BaseOutputPath)$(Configuration)\ + + WiX Toolset Team + WiX Toolset + Copyright (c) .NET Foundation and contributors. All rights reserved. + MS-RL + WiX Toolset + + + + + diff --git a/src/wix/Directory.Build.targets b/src/wix/Directory.Build.targets new file mode 100644 index 00000000..2fcc765a --- /dev/null +++ b/src/wix/Directory.Build.targets @@ -0,0 +1,51 @@ + + + + + + + true + $(SolutionPath) + $(NCrunchOriginalSolutionPath) + + + + + + + $([System.IO.File]::ReadAllText($(TheSolutionPath))) + $([System.IO.Path]::GetDirectoryName( $(TheSolutionPath) )) + (?<="[PackageName]", ")(.*)(?=", ") + + + + + + %(Identity) + $(SolutionFileContent.Contains('\%(Identity).csproj')) + + + + + $(RegexPattern.Replace('[PackageName]','%(PackageName)') ) + $([System.Text.RegularExpressions.Regex]::Match('$(SolutionFileContent)', '%(Pattern)')) + + + + + + + + + + + + + + diff --git a/src/wix/Directory.csproj.props b/src/wix/Directory.csproj.props new file mode 100644 index 00000000..81d24ad1 --- /dev/null +++ b/src/wix/Directory.csproj.props @@ -0,0 +1,13 @@ + + + + + true + true + $([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk)) + false + + diff --git a/src/wix/Directory.csproj.targets b/src/wix/Directory.csproj.targets new file mode 100644 index 00000000..c3270426 --- /dev/null +++ b/src/wix/Directory.csproj.targets @@ -0,0 +1,26 @@ + + + + + false + $(OutputPath)\$(AssemblyName).xml + + + + + $(PrivateRepositoryUrl.Replace('.git','')) + + $(MSBuildProjectName).nuspec + $(OutputPath)..\ + $(NuspecProperties);Id=$(PackageId);Authors=$(Authors);Copyright=$(Copyright);Description=$(Description);Title=$(Title) + $(NuspecProperties);Version=$(PackageVersion);RepositoryCommit=$(SourceRevisionId);RepositoryType=$(RepositoryType);RepositoryUrl=$(PrivateRepositoryUrl);ProjectFolder=$(MSBuildProjectDirectory)\;ProjectUrl=$(ProjectUrl) + true + snupkg + + + + diff --git a/src/wix/README.md b/src/wix/README.md new file mode 100644 index 00000000..f031cf7c --- /dev/null +++ b/src/wix/README.md @@ -0,0 +1,2 @@ +# Converters +WixToolset.Converters, conversion related functionality diff --git a/src/wix/WixToolset.Converters.Symbolizer/ConvertSymbols.cs b/src/wix/WixToolset.Converters.Symbolizer/ConvertSymbols.cs new file mode 100644 index 00000000..6418b2a6 --- /dev/null +++ b/src/wix/WixToolset.Converters.Symbolizer/ConvertSymbols.cs @@ -0,0 +1,876 @@ +// 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.Converters.Symbolizer +{ + using System; + using System.Collections.Generic; + using System.Linq; + using WixToolset.Data; + using WixToolset.Data.Symbols; + using WixToolset.Data.WindowsInstaller; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + +#pragma warning disable 1591 // TODO: add documentation + public static class ConvertSymbols + { + public static Intermediate ConvertFile(string path) + { + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + return ConvertOutput(output); + } + + public static Intermediate ConvertOutput(Wix3.Output output) +#pragma warning restore 1591 + { + var section = new IntermediateSection(String.Empty, OutputType3ToSectionType4(output.Type)); + + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + var componentsById = IndexById(output, "Component"); + var bindPathsById = IndexById(output, "BindPath"); + var fontsById = IndexById(output, "Font"); + var selfRegById = IndexById(output, "SelfReg"); + var wixDirectoryById = IndexById(output, "WixDirectory"); + var wixFileById = IndexById(output, "WixFile"); + + foreach (Wix3.Table table in output.Tables) + { + foreach (Wix3.Row row in table.Rows) + { + var symbol = GenerateSymbolFromRow(row, wixMediaByDiskId, componentsById, fontsById, bindPathsById, selfRegById, wixFileById, wixDirectoryById); + if (symbol != null) + { + section.AddSymbol(symbol); + } + } + } + + return new Intermediate(String.Empty, new[] { section }, localizationsByCulture: null); + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add(FieldAsInt(row, 0), row); + } + } + + return wixMediaByDiskId; + } + + private static Dictionary IndexById(Wix3.Output output, string tableName) where T : Wix3.Row + { + var byId = new Dictionary(); + var table = output.Tables[tableName]; + + if (table != null) + { + foreach (T row in table.Rows) + { + byId.Add(FieldAsString(row, 0), row); + } + } + + return byId; + } + + private static IntermediateSymbol GenerateSymbolFromRow(Wix3.Row row, Dictionary wixMediaByDiskId, Dictionary componentsById, Dictionary fontsById, Dictionary bindPathsById, Dictionary selfRegById, Dictionary wixFileById, Dictionary wixDirectoryById) + { + var name = row.Table.Name; + switch (name) + { + case "_SummaryInformation": + return DefaultSymbolFromRow(typeof(SummaryInformationSymbol), row, columnZeroIsId: false); + case "ActionText": + return DefaultSymbolFromRow(typeof(ActionTextSymbol), row, columnZeroIsId: false); + case "AppId": + return DefaultSymbolFromRow(typeof(AppIdSymbol), row, columnZeroIsId: false); + case "AppSearch": + return DefaultSymbolFromRow(typeof(AppSearchSymbol), row, columnZeroIsId: false); + case "Billboard": + return DefaultSymbolFromRow(typeof(BillboardSymbol), row, columnZeroIsId: true); + case "Binary": + return DefaultSymbolFromRow(typeof(BinarySymbol), row, columnZeroIsId: true); + case "BindPath": + return null; + case "CCPSearch": + return DefaultSymbolFromRow(typeof(CCPSearchSymbol), row, columnZeroIsId: true); + case "Class": + return DefaultSymbolFromRow(typeof(ClassSymbol), row, columnZeroIsId: false); + case "CompLocator": + return DefaultSymbolFromRow(typeof(CompLocatorSymbol), row, columnZeroIsId: false); + case "Component": + { + var attributes = FieldAsNullableInt(row, 3); + + var location = ComponentLocation.LocalOnly; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) == WindowsInstallerConstants.MsidbComponentAttributesSourceOnly) + { + location = ComponentLocation.SourceOnly; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesOptional) == WindowsInstallerConstants.MsidbComponentAttributesOptional) + { + location = ComponentLocation.Either; + } + + var keyPath = FieldAsString(row, 5); + var keyPathType = String.IsNullOrEmpty(keyPath) ? ComponentKeyPathType.Directory : ComponentKeyPathType.File; + if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) == WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath) + { + keyPathType = ComponentKeyPathType.Registry; + } + else if ((attributes & WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) == WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource) + { + keyPathType = ComponentKeyPathType.OdbcDataSource; + } + + return new ComponentSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + ComponentId = FieldAsString(row, 1), + DirectoryRef = FieldAsString(row, 2), + Condition = FieldAsString(row, 4), + KeyPath = keyPath, + Location = location, + DisableRegistryReflection = (attributes & WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection) == WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection, + NeverOverwrite = (attributes & WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite) == WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite, + Permanent = (attributes & WindowsInstallerConstants.MsidbComponentAttributesPermanent) == WindowsInstallerConstants.MsidbComponentAttributesPermanent, + SharedDllRefCount = (attributes & WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount) == WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount, + Shared = (attributes & WindowsInstallerConstants.MsidbComponentAttributesShared) == WindowsInstallerConstants.MsidbComponentAttributesShared, + Transitive = (attributes & WindowsInstallerConstants.MsidbComponentAttributesTransitive) == WindowsInstallerConstants.MsidbComponentAttributesTransitive, + UninstallWhenSuperseded = (attributes & WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence) == WindowsInstallerConstants.MsidbComponentAttributesUninstallOnSupersedence, + Win64 = (attributes & WindowsInstallerConstants.MsidbComponentAttributes64bit) == WindowsInstallerConstants.MsidbComponentAttributes64bit, + KeyPathType = keyPathType, + }; + } + + case "Condition": + return DefaultSymbolFromRow(typeof(ConditionSymbol), row, columnZeroIsId: false); + case "CreateFolder": + return DefaultSymbolFromRow(typeof(CreateFolderSymbol), row, columnZeroIsId: false); + case "CustomAction": + { + var caType = FieldAsInt(row, 1); + var executionType = DetermineCustomActionExecutionType(caType); + var sourceType = DetermineCustomActionSourceType(caType); + var targetType = DetermineCustomActionTargetType(caType); + + return new CustomActionSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + ExecutionType = executionType, + SourceType = sourceType, + Source = FieldAsString(row, 2), + TargetType = targetType, + Target = FieldAsString(row, 3), + Win64 = (caType & WindowsInstallerConstants.MsidbCustomActionType64BitScript) == WindowsInstallerConstants.MsidbCustomActionType64BitScript, + TSAware = (caType & WindowsInstallerConstants.MsidbCustomActionTypeTSAware) == WindowsInstallerConstants.MsidbCustomActionTypeTSAware, + Impersonate = (caType & WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate) != WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate, + IgnoreResult = (caType & WindowsInstallerConstants.MsidbCustomActionTypeContinue) == WindowsInstallerConstants.MsidbCustomActionTypeContinue, + Hidden = (caType & WindowsInstallerConstants.MsidbCustomActionTypeHideTarget) == WindowsInstallerConstants.MsidbCustomActionTypeHideTarget, + Async = (caType & WindowsInstallerConstants.MsidbCustomActionTypeAsync) == WindowsInstallerConstants.MsidbCustomActionTypeAsync, + }; + } + + case "Directory": + { + var id = FieldAsString(row, 0); + var splits = SplitDefaultDir(FieldAsString(row, 2)); + + var symbol = new DirectorySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, id)) + { + ParentDirectoryRef = FieldAsString(row, 1), + Name = splits[0], + ShortName = splits[1], + SourceName = splits[2], + SourceShortName = splits[3] + }; + + if (wixDirectoryById.TryGetValue(id, out var wixDirectoryRow)) + { + symbol.ComponentGuidGenerationSeed = FieldAsString(wixDirectoryRow, 1); + } + + return symbol; + } + case "DrLocator": + return DefaultSymbolFromRow(typeof(DrLocatorSymbol), row, columnZeroIsId: false); + case "DuplicateFile": + { + var splitName = FieldAsString(row, 3)?.Split('|'); + + var symbol = new DuplicateFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileRef = FieldAsString(row, 2), + DestinationName = splitName == null ? null : splitName.Length > 1 ? splitName[1] : splitName[0], + DestinationShortName = splitName == null ? null : splitName.Length > 1 ? splitName[0] : null, + DestinationFolder = FieldAsString(row, 4) + }; + + return symbol; + } + case "Error": + return DefaultSymbolFromRow(typeof(ErrorSymbol), row, columnZeroIsId: false); + case "Extension": + return DefaultSymbolFromRow(typeof(ExtensionSymbol), row, columnZeroIsId: false); + case "Feature": + { + var attributes = FieldAsInt(row, 7); + var installDefault = FeatureInstallDefault.Local; + if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) == WindowsInstallerConstants.MsidbFeatureAttributesFollowParent) + { + installDefault = FeatureInstallDefault.FollowParent; + } + else if ((attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) == WindowsInstallerConstants.MsidbFeatureAttributesFavorSource) + { + installDefault = FeatureInstallDefault.Source; + } + + return new FeatureSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + ParentFeatureRef = FieldAsString(row, 1), + Title = FieldAsString(row, 2), + Description = FieldAsString(row, 3), + Display = FieldAsInt(row, 4), // BUGBUGBUG: FieldAsNullableInt(row, 4), + Level = FieldAsInt(row, 5), + DirectoryRef = FieldAsString(row, 6), + DisallowAbsent = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent) == WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent, + DisallowAdvertise = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise, + InstallDefault = installDefault, + TypicalDefault = (attributes & WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise) == WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise ? FeatureTypicalDefault.Advertise : FeatureTypicalDefault.Install, + }; + } + + case "FeatureComponents": + return DefaultSymbolFromRow(typeof(FeatureComponentsSymbol), row, columnZeroIsId: false); + case "File": + { + var attributes = FieldAsNullableInt(row, 6); + + FileSymbolAttributes symbolAttributes = 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesReadOnly) == WindowsInstallerConstants.MsidbFileAttributesReadOnly ? FileSymbolAttributes.ReadOnly : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesHidden) == WindowsInstallerConstants.MsidbFileAttributesHidden ? FileSymbolAttributes.Hidden : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesSystem) == WindowsInstallerConstants.MsidbFileAttributesSystem ? FileSymbolAttributes.System : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesVital) == WindowsInstallerConstants.MsidbFileAttributesVital ? FileSymbolAttributes.Vital : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesChecksum) == WindowsInstallerConstants.MsidbFileAttributesChecksum ? FileSymbolAttributes.Checksum : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesNoncompressed) == WindowsInstallerConstants.MsidbFileAttributesNoncompressed ? FileSymbolAttributes.Uncompressed : 0; + symbolAttributes |= (attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed ? FileSymbolAttributes.Compressed : 0; + + var id = FieldAsString(row, 0); + var splitName = FieldAsString(row, 2).Split('|'); + + var symbol = new FileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, id)) + { + ComponentRef = FieldAsString(row, 1), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, + FileSize = FieldAsInt(row, 3), + Version = FieldAsString(row, 4), + Language = FieldAsString(row, 5), + Attributes = symbolAttributes + }; + + if (bindPathsById.TryGetValue(id, out var bindPathRow)) + { + symbol.BindPath = FieldAsString(bindPathRow, 1) ?? String.Empty; + } + + if (fontsById.TryGetValue(id, out var fontRow)) + { + symbol.FontTitle = FieldAsString(fontRow, 1) ?? String.Empty; + } + + if (selfRegById.TryGetValue(id, out var selfRegRow)) + { + symbol.SelfRegCost = FieldAsNullableInt(selfRegRow, 1) ?? 0; + } + + if (wixFileById.TryGetValue(id, out var wixFileRow)) + { + symbol.DirectoryRef = FieldAsString(wixFileRow, 4); + symbol.DiskId = FieldAsNullableInt(wixFileRow, 5) ?? 0; + symbol.Source = new IntermediateFieldPathValue { Path = FieldAsString(wixFileRow, 6) }; + symbol.PatchGroup = FieldAsInt(wixFileRow, 8); + symbol.PatchAttributes = (PatchAttributeType)FieldAsInt(wixFileRow, 10); + } + + return symbol; + } + case "Font": + return null; + case "Icon": + return DefaultSymbolFromRow(typeof(IconSymbol), row, columnZeroIsId: true); + case "IniFile": + { + var splitName = FieldAsString(row, 1).Split('|'); + var action = FieldAsInt(row, 6); + + var symbol = new IniFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + FileName = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortFileName = splitName.Length > 1 ? splitName[0] : null, + DirProperty = FieldAsString(row, 2), + Section = FieldAsString(row, 3), + Key = FieldAsString(row, 4), + Value = FieldAsString(row, 5), + Action = action == 3 ? IniFileActionType.AddTag : action == 1 ? IniFileActionType.CreateLine : IniFileActionType.AddLine, + ComponentRef = FieldAsString(row, 7), + }; + + return symbol; + } + case "IniLocator": + { + var splitName = FieldAsString(row, 1).Split('|'); + + var symbol = new IniLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + FileName = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortFileName = splitName.Length > 1 ? splitName[0] : null, + Section = FieldAsString(row, 2), + Key = FieldAsString(row, 3), + Field = FieldAsInt(row, 4), + Type = FieldAsInt(row, 5), + }; + + return symbol; + } + case "LockPermissions": + return DefaultSymbolFromRow(typeof(LockPermissionsSymbol), row, columnZeroIsId: false); + case "Media": + { + var diskId = FieldAsInt(row, 0); + var symbol = new MediaSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, diskId)) + { + DiskId = diskId, + LastSequence = FieldAsNullableInt(row, 1), + DiskPrompt = FieldAsString(row, 2), + Cabinet = FieldAsString(row, 3), + VolumeLabel = FieldAsString(row, 4), + Source = FieldAsString(row, 5) + }; + + if (wixMediaByDiskId.TryGetValue(diskId, out var wixMediaRow)) + { + var compressionLevel = FieldAsString(wixMediaRow, 1); + + symbol.CompressionLevel = String.IsNullOrEmpty(compressionLevel) ? null : (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), compressionLevel, true); + symbol.Layout = wixMediaRow.Layout; + } + + return symbol; + } + case "MIME": + return DefaultSymbolFromRow(typeof(MIMESymbol), row, columnZeroIsId: false); + case "ModuleIgnoreTable": + return DefaultSymbolFromRow(typeof(ModuleIgnoreTableSymbol), row, columnZeroIsId: true); + case "MoveFile": + return DefaultSymbolFromRow(typeof(MoveFileSymbol), row, columnZeroIsId: true); + case "MsiAssembly": + { + var componentId = FieldAsString(row, 0); + if (componentsById.TryGetValue(componentId, out var componentRow)) + { + return new AssemblySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(componentRow, 5))) + { + ComponentRef = componentId, + FeatureRef = FieldAsString(row, 1), + ManifestFileRef = FieldAsString(row, 2), + ApplicationFileRef = FieldAsString(row, 3), + Type = FieldAsNullableInt(row, 4) == 1 ? AssemblyType.Win32Assembly : AssemblyType.DotNetAssembly, + }; + } + + return null; + } + case "MsiLockPermissionsEx": + return DefaultSymbolFromRow(typeof(MsiLockPermissionsExSymbol), row, columnZeroIsId: true); + case "MsiShortcutProperty": + return DefaultSymbolFromRow(typeof(MsiShortcutPropertySymbol), row, columnZeroIsId: true); + case "ODBCDataSource": + return DefaultSymbolFromRow(typeof(ODBCDataSourceSymbol), row, columnZeroIsId: true); + case "ODBCDriver": + return DefaultSymbolFromRow(typeof(ODBCDriverSymbol), row, columnZeroIsId: true); + case "ODBCTranslator": + return DefaultSymbolFromRow(typeof(ODBCTranslatorSymbol), row, columnZeroIsId: true); + case "ProgId": + return DefaultSymbolFromRow(typeof(ProgIdSymbol), row, columnZeroIsId: false); + case "Property": + return DefaultSymbolFromRow(typeof(PropertySymbol), row, columnZeroIsId: true); + case "PublishComponent": + return DefaultSymbolFromRow(typeof(PublishComponentSymbol), row, columnZeroIsId: false); + case "Registry": + { + var value = FieldAsString(row, 4); + var valueType = RegistryValueType.String; + var valueAction = RegistryValueActionType.Write; + + if (!String.IsNullOrEmpty(value)) + { + if (value.StartsWith("#x", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Binary; + value = value.Substring(2); + } + else if (value.StartsWith("#%", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Expandable; + value = value.Substring(2); + } + else if (value.StartsWith("#", StringComparison.Ordinal)) + { + valueType = RegistryValueType.Integer; + value = value.Substring(1); + } + else if (value.StartsWith("[~]", StringComparison.Ordinal) && value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3, value.Length - 6); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Write; + } + else if (value.StartsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Append; + } + else if (value.EndsWith("[~]", StringComparison.Ordinal)) + { + value = value.Substring(0, value.Length - 3); + valueType = RegistryValueType.MultiString; + valueAction = RegistryValueActionType.Prepend; + } + } + + return new RegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Value = value, + ComponentRef = FieldAsString(row, 5), + ValueAction = valueAction, + ValueType = valueType, + }; + } + case "RegLocator": + { + var type = FieldAsInt(row, 4); + + return new RegLocatorSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + Type = (RegLocatorType)(type & 0xF), + Win64 = (type & WindowsInstallerConstants.MsidbLocatorType64bit) == WindowsInstallerConstants.MsidbLocatorType64bit + }; + } + case "RemoveFile": + { + var splitName = FieldAsString(row, 2).Split('|'); + var installMode = FieldAsInt(row, 4); + + return new RemoveFileSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + ComponentRef = FieldAsString(row, 1), + FileName = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortFileName = splitName.Length > 1 ? splitName[0] : null, + DirPropertyRef = FieldAsString(row, 3), + OnInstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnInstall ? (bool?)true : null, + OnUninstall = (installMode & WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove) == WindowsInstallerConstants.MsidbRemoveFileInstallModeOnRemove ? (bool?)true : null + }; + } + case "RemoveRegistry": + { + return new RemoveRegistrySymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + Action = RemoveRegistryActionType.RemoveOnInstall, + Root = (RegistryRootType)FieldAsInt(row, 1), + Key = FieldAsString(row, 2), + Name = FieldAsString(row, 3), + ComponentRef = FieldAsString(row, 4), + }; + } + + case "ReserveCost": + return DefaultSymbolFromRow(typeof(ReserveCostSymbol), row, columnZeroIsId: true); + case "SelfReg": + return null; + case "ServiceControl": + { + var events = FieldAsInt(row, 2); + var wait = FieldAsNullableInt(row, 4); + return new ServiceControlSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + Name = FieldAsString(row, 1), + Arguments = FieldAsString(row, 3), + Wait = !wait.HasValue || wait.Value == 1, + ComponentRef = FieldAsString(row, 5), + InstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventDelete) == WindowsInstallerConstants.MsidbServiceControlEventDelete, + UninstallRemove = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete) == WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete, + InstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventStart) == WindowsInstallerConstants.MsidbServiceControlEventStart, + UninstallStart = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStart) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStart, + InstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventStop) == WindowsInstallerConstants.MsidbServiceControlEventStop, + UninstallStop = (events & WindowsInstallerConstants.MsidbServiceControlEventUninstallStop) == WindowsInstallerConstants.MsidbServiceControlEventUninstallStop, + }; + } + + case "ServiceInstall": + return DefaultSymbolFromRow(typeof(ServiceInstallSymbol), row, columnZeroIsId: true); + case "Shortcut": + { + var splitName = FieldAsString(row, 2).Split('|'); + + return new ShortcutSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + DirectoryRef = FieldAsString(row, 1), + Name = splitName.Length > 1 ? splitName[1] : splitName[0], + ShortName = splitName.Length > 1 ? splitName[0] : null, + ComponentRef = FieldAsString(row, 3), + Target = FieldAsString(row, 4), + Arguments = FieldAsString(row, 5), + Description = FieldAsString(row, 6), + Hotkey = FieldAsNullableInt(row, 7), + IconRef = FieldAsString(row, 8), + IconIndex = FieldAsNullableInt(row, 9), + Show = (ShortcutShowType?)FieldAsNullableInt(row, 10), + WorkingDirectory = FieldAsString(row, 11), + DisplayResourceDll = FieldAsString(row, 12), + DisplayResourceId = FieldAsNullableInt(row, 13), + DescriptionResourceDll = FieldAsString(row, 14), + DescriptionResourceId= FieldAsNullableInt(row, 15), + }; + } + case "Signature": + return DefaultSymbolFromRow(typeof(SignatureSymbol), row, columnZeroIsId: true); + case "UIText": + return DefaultSymbolFromRow(typeof(UITextSymbol), row, columnZeroIsId: true); + case "Upgrade": + { + var attributes = FieldAsInt(row, 4); + return new UpgradeSymbol(SourceLineNumber4(row.SourceLineNumbers), new Identifier(AccessModifier.Global, FieldAsString(row, 0))) + { + UpgradeCode = FieldAsString(row, 0), + VersionMin = FieldAsString(row, 1), + VersionMax = FieldAsString(row, 2), + Language = FieldAsString(row, 3), + Remove = FieldAsString(row, 5), + ActionProperty = FieldAsString(row, 6), + MigrateFeatures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures) == WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures, + OnlyDetect = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect) == WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect, + IgnoreRemoveFailures = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure) == WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure, + VersionMinInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive, + VersionMaxInclusive = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive, + ExcludeLanguages = (attributes & WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive) == WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive, + }; + } + case "Verb": + return DefaultSymbolFromRow(typeof(VerbSymbol), row, columnZeroIsId: false); + case "WixAction": + { + var sequenceTable = FieldAsString(row, 0); + return new WixActionSymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + SequenceTable = (SequenceTable)Enum.Parse(typeof(SequenceTable), sequenceTable == "AdvtExecuteSequence" ? nameof(SequenceTable.AdvertiseExecuteSequence) : sequenceTable), + Action = FieldAsString(row, 1), + Condition = FieldAsString(row, 2), + Sequence = FieldAsNullableInt(row, 3), + Before = FieldAsString(row, 4), + After = FieldAsString(row, 5), + Overridable = FieldAsNullableInt(row, 6) != 0, + }; + } + case "WixBootstrapperApplication": + return DefaultSymbolFromRow(typeof(WixBootstrapperApplicationSymbol), row, columnZeroIsId: true); + case "WixBundleContainer": + return DefaultSymbolFromRow(typeof(WixBundleContainerSymbol), row, columnZeroIsId: true); + case "WixBundleVariable": + return DefaultSymbolFromRow(typeof(WixBundleVariableSymbol), row, columnZeroIsId: true); + case "WixChainItem": + return DefaultSymbolFromRow(typeof(WixChainItemSymbol), row, columnZeroIsId: true); + case "WixCustomTable": + return DefaultSymbolFromRow(typeof(WixCustomTableSymbol), row, columnZeroIsId: true); + case "WixDirectory": + return null; + case "WixFile": + return null; + case "WixInstanceTransforms": + return DefaultSymbolFromRow(typeof(WixInstanceTransformsSymbol), row, columnZeroIsId: true); + case "WixMedia": + return null; + case "WixMerge": + return DefaultSymbolFromRow(typeof(WixMergeSymbol), row, columnZeroIsId: true); + case "WixPatchBaseline": + return DefaultSymbolFromRow(typeof(WixPatchBaselineSymbol), row, columnZeroIsId: true); + case "WixProperty": + { + var attributes = FieldAsInt(row, 1); + return new WixPropertySymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + PropertyRef = FieldAsString(row, 0), + Admin = (attributes & 0x1) == 0x1, + Hidden = (attributes & 0x2) == 0x2, + Secure = (attributes & 0x4) == 0x4, + }; + } + case "WixSuppressModularization": + { + return new WixSuppressModularizationSymbol(SourceLineNumber4(row.SourceLineNumbers)) + { + SuppressIdentifier = FieldAsString(row, 0) + }; + } + case "WixUI": + return DefaultSymbolFromRow(typeof(WixUISymbol), row, columnZeroIsId: true); + case "WixVariable": + return DefaultSymbolFromRow(typeof(WixVariableSymbol), row, columnZeroIsId: true); + default: + return GenericSymbolFromCustomRow(row, columnZeroIsId: false); + } + } + + private static CustomActionTargetType DetermineCustomActionTargetType(int type) + { + var targetType = default(CustomActionTargetType); + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeVBScript) == WindowsInstallerConstants.MsidbCustomActionTypeVBScript) + { + targetType = CustomActionTargetType.VBScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeJScript) == WindowsInstallerConstants.MsidbCustomActionTypeJScript) + { + targetType = CustomActionTargetType.JScript; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeTextData) == WindowsInstallerConstants.MsidbCustomActionTypeTextData) + { + targetType = CustomActionTargetType.TextData; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeExe) == WindowsInstallerConstants.MsidbCustomActionTypeExe) + { + targetType = CustomActionTargetType.Exe; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDll) == WindowsInstallerConstants.MsidbCustomActionTypeDll) + { + targetType = CustomActionTargetType.Dll; + } + + return targetType; + } + + private static CustomActionSourceType DetermineCustomActionSourceType(int type) + { + var sourceType = CustomActionSourceType.Binary; + + if ((type & WindowsInstallerConstants.MsidbCustomActionTypeProperty) == WindowsInstallerConstants.MsidbCustomActionTypeProperty) + { + sourceType = CustomActionSourceType.Property; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeDirectory) == WindowsInstallerConstants.MsidbCustomActionTypeDirectory) + { + sourceType = CustomActionSourceType.Directory; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) == WindowsInstallerConstants.MsidbCustomActionTypeSourceFile) + { + sourceType = CustomActionSourceType.File; + } + + return sourceType; + } + + private static CustomActionExecutionType DetermineCustomActionExecutionType(int type) + { + var executionType = CustomActionExecutionType.Immediate; + + if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit)) + { + executionType = CustomActionExecutionType.Commit; + } + else if ((type & (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) == (WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback)) + { + executionType = CustomActionExecutionType.Rollback; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeInScript) == WindowsInstallerConstants.MsidbCustomActionTypeInScript) + { + executionType = CustomActionExecutionType.Deferred; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) == WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat) + { + executionType = CustomActionExecutionType.ClientRepeat; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) == WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess) + { + executionType = CustomActionExecutionType.OncePerProcess; + } + else if ((type & WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) == WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence) + { + executionType = CustomActionExecutionType.FirstSequence; + } + + return executionType; + } + + private static IntermediateFieldType ColumnType3ToIntermediateFieldType4(Wix3.ColumnType columnType) + { + switch (columnType) + { + case Wix3.ColumnType.Number: + return IntermediateFieldType.Number; + case Wix3.ColumnType.Object: + return IntermediateFieldType.Path; + case Wix3.ColumnType.Unknown: + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Preserved: + default: + return IntermediateFieldType.String; + } + } + + private static IntermediateSymbol DefaultSymbolFromRow(Type symbolType, Wix3.Row row, bool columnZeroIsId) + { + var id = columnZeroIsId ? GetIdentifierForRow(row) : null; + + var createSymbol = symbolType.GetConstructor(new[] { typeof(SourceLineNumber), typeof(Identifier) }); + var symbol = (IntermediateSymbol)createSymbol.Invoke(new object[] { SourceLineNumber4(row.SourceLineNumbers), id }); + + SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); + + return symbol; + } + + private static IntermediateSymbol GenericSymbolFromCustomRow(Wix3.Row row, bool columnZeroIsId) + { + var columnDefinitions = row.Table.Definition.Columns.Cast(); + var fieldDefinitions = columnDefinitions.Select(columnDefinition => + new IntermediateFieldDefinition(columnDefinition.Name, ColumnType3ToIntermediateFieldType4(columnDefinition.Type))).ToArray(); + var symbolDefinition = new IntermediateSymbolDefinition(row.Table.Name, fieldDefinitions, null); + + var id = columnZeroIsId ? GetIdentifierForRow(row) : null; + + var createSymbol = typeof(IntermediateSymbol).GetConstructor(new[] { typeof(IntermediateSymbolDefinition), typeof(SourceLineNumber), typeof(Identifier) }); + var symbol = (IntermediateSymbol)createSymbol.Invoke(new object[] { symbolDefinition, SourceLineNumber4(row.SourceLineNumbers), id }); + + SetSymbolFieldsFromRow(row, symbol, columnZeroIsId); + + return symbol; + } + + private static void SetSymbolFieldsFromRow(Wix3.Row row, IntermediateSymbol symbol, bool columnZeroIsId) + { + var offset = 0; + if (columnZeroIsId) + { + offset = 1; + } + + for (var i = offset; i < row.Fields.Length; ++i) + { + var column = row.Fields[i].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + symbol.Set(i - offset, FieldAsString(row, i)); + break; + case Wix3.ColumnType.Number: + int? nullableValue = FieldAsNullableInt(row, i); + // TODO: Consider whether null values should be coerced to their default value when + // a column is not nullable. For now, just pass through the null. + //int value = FieldAsInt(row, i); + //symbol.Set(i - offset, column.IsNullable ? nullableValue : value); + symbol.Set(i - offset, nullableValue); + break; + case Wix3.ColumnType.Unknown: + break; + } + } + } + + private static Identifier GetIdentifierForRow(Wix3.Row row) + { + var column = row.Fields[0].Column; + switch (column.Type) + { + case Wix3.ColumnType.String: + case Wix3.ColumnType.Localized: + case Wix3.ColumnType.Object: + case Wix3.ColumnType.Preserved: + return new Identifier(AccessModifier.Global, (string)row.Fields[0].Data); + case Wix3.ColumnType.Number: + return new Identifier(AccessModifier.Global, FieldAsInt(row, 0)); + default: + return null; + } + } + + private static SectionType OutputType3ToSectionType4(Wix3.OutputType outputType) + { + switch (outputType) + { + case Wix3.OutputType.Bundle: + return SectionType.Bundle; + case Wix3.OutputType.Module: + return SectionType.Module; + case Wix3.OutputType.Patch: + return SectionType.Patch; + case Wix3.OutputType.PatchCreation: + return SectionType.PatchCreation; + case Wix3.OutputType.Product: + return SectionType.Product; + case Wix3.OutputType.Transform: + case Wix3.OutputType.Unknown: + default: + return SectionType.Unknown; + } + } + + private static SourceLineNumber SourceLineNumber4(Wix3.SourceLineNumberCollection source) + { + return String.IsNullOrEmpty(source?.EncodedSourceLineNumbers) ? null : SourceLineNumber.CreateFromEncoded(source.EncodedSourceLineNumbers); + } + + private static string FieldAsString(Wix3.Row row, int column) + { + return (string)row[column]; + } + + private static int FieldAsInt(Wix3.Row row, int column) + { + return Convert.ToInt32(row[column]); + } + + private static int? FieldAsNullableInt(Wix3.Row row, int column) + { + var field = row.Fields[column]; + if (field.Data == null) + { + return null; + } + else + { + return Convert.ToInt32(field.Data); + } + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : null, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : null + }; + } + } +} diff --git a/src/wix/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/wix/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj new file mode 100644 index 00000000..445c3500 --- /dev/null +++ b/src/wix/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj @@ -0,0 +1,32 @@ + + + + + + + netstandard2.0 + $(TargetFrameworks);net461;net472 + Symbolizer + WiX Toolset Converters Tuplizer + embedded + true + true + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/WixToolset.Converters.sln b/src/wix/WixToolset.Converters.sln new file mode 100644 index 00000000..ae8a3d92 --- /dev/null +++ b/src/wix/WixToolset.Converters.sln @@ -0,0 +1,85 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26124.0 +MinimumVisualStudioVersion = 15.0.26124.0 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters", "WixToolset.Converters\WixToolset.Converters.csproj", "{6FAF6385-6598-4B89-972B-C31AFCA14538}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolset.Converters.Symbolizer", "WixToolset.Converters.Symbolizer\WixToolset.Converters.Symbolizer.csproj", "{F051BCAF-698C-41D5-8427-164537CE5C5C}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters", "test\WixToolsetTest.Converters\WixToolsetTest.Converters.csproj", "{485C5038-97E1-4729-A54D-848CC69569FD}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WixToolsetTest.Converters.Symbolizer", "test\WixToolsetTest.Converters.Symbolizer\WixToolsetTest.Converters.Symbolizer.csproj", "{9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 + Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x64.ActiveCfg = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x64.Build.0 = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x86.ActiveCfg = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Debug|x86.Build.0 = Debug|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|Any CPU.Build.0 = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x64.ActiveCfg = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x64.Build.0 = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x86.ActiveCfg = Release|Any CPU + {F051BCAF-698C-41D5-8427-164537CE5C5C}.Release|x86.Build.0 = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x64.ActiveCfg = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x64.Build.0 = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x86.ActiveCfg = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Debug|x86.Build.0 = Debug|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|Any CPU.Build.0 = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x64.ActiveCfg = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x64.Build.0 = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x86.ActiveCfg = Release|Any CPU + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C}.Release|x86.Build.0 = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x64.ActiveCfg = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x64.Build.0 = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x86.ActiveCfg = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Debug|x86.Build.0 = Debug|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|Any CPU.Build.0 = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x64.ActiveCfg = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x64.Build.0 = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x86.ActiveCfg = Release|Any CPU + {6FAF6385-6598-4B89-972B-C31AFCA14538}.Release|x86.Build.0 = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|Any CPU.Build.0 = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x64.ActiveCfg = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x64.Build.0 = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x86.ActiveCfg = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Debug|x86.Build.0 = Debug|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|Any CPU.ActiveCfg = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|Any CPU.Build.0 = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x64.ActiveCfg = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x64.Build.0 = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x86.ActiveCfg = Release|Any CPU + {485C5038-97E1-4729-A54D-848CC69569FD}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {9DB36DB1-24A1-47A7-9E57-D48A2E33C13C} = {1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E} + {485C5038-97E1-4729-A54D-848CC69569FD} = {1B16A6C1-2B5D-4F9A-9DD5-FBC89B3CE31E} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {2E71F0EC-CF75-44DA-8353-7066EBD06564} + EndGlobalSection +EndGlobal diff --git a/src/wix/WixToolset.Converters.v3.ncrunchsolution b/src/wix/WixToolset.Converters.v3.ncrunchsolution new file mode 100644 index 00000000..f774ab93 --- /dev/null +++ b/src/wix/WixToolset.Converters.v3.ncrunchsolution @@ -0,0 +1,6 @@ + + + False + True + + \ No newline at end of file diff --git a/src/wix/WixToolset.Converters/ConvertCommand.cs b/src/wix/WixToolset.Converters/ConvertCommand.cs new file mode 100644 index 00000000..b6826f43 --- /dev/null +++ b/src/wix/WixToolset.Converters/ConvertCommand.cs @@ -0,0 +1,60 @@ +// 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.Converters +{ + using System; + using System.Threading; + using System.Threading.Tasks; + using WixToolset.Extensibility.Services; + + internal class ConvertCommand : FixupCommandBase + { + private const string SettingsFileDefault = "wix.convert.settings.xml"; + + public ConvertCommand(IServiceProvider serviceProvider) + { + this.Messaging = serviceProvider.GetService(); + } + + private IMessaging Messaging { get; } + + public override Task ExecuteAsync(CancellationToken cancellationToken) + { + if (this.ShowHelp) + { + DisplayHelp(); + return Task.FromResult(-1); + } + + this.ParseSettings(SettingsFileDefault); + + var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); + + var errors = base.Inspect(Inspector, cancellationToken); + + return Task.FromResult(errors); + + int Inspector(string file, bool fix) + { + return converter.ConvertFile(file, fix); + } + } + + private static void DisplayHelp() + { + Console.WriteLine(); + Console.WriteLine("Usage: wix convert [options] sourceFile [sourceFile ...]"); + Console.WriteLine(); + Console.WriteLine("Options:"); + Console.WriteLine(" -h|--help Show command line help."); + Console.WriteLine(" --nologo Suppress displaying the logo information."); + Console.WriteLine(" -n|--dry-run Only display errors, do not update files."); + Console.WriteLine(" -r|--recurse Search for matching files in current dir and subdirs."); + Console.WriteLine(" -set1 Primary settings file."); + Console.WriteLine(" -set2 Secondary settings file (overrides primary)."); + Console.WriteLine(" -indent: Indentation multiple (overrides default of 4)."); + Console.WriteLine(); + Console.WriteLine(" sourceFile may use wildcards like *.wxs"); + } + } +} diff --git a/src/wix/WixToolset.Converters/ConverterExtensionCommandLine.cs b/src/wix/WixToolset.Converters/ConverterExtensionCommandLine.cs new file mode 100644 index 00000000..06d3658c --- /dev/null +++ b/src/wix/WixToolset.Converters/ConverterExtensionCommandLine.cs @@ -0,0 +1,46 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + /// + /// Parses the "convert" command-line command. See ConvertCommand for + /// the bulk of the command-line processing. + /// + internal class ConverterExtensionCommandLine : BaseExtensionCommandLine + { + public ConverterExtensionCommandLine(IServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + } + + private IServiceProvider ServiceProvider { get; } + + public override IReadOnlyCollection CommandLineSwitches => new ExtensionCommandLineSwitch[] + { + new ExtensionCommandLineSwitch { Switch = "convert", Description = "Convert v3 source code to v4 source code." }, + new ExtensionCommandLineSwitch { Switch = "format", Description = "Ensures consistent formatting of source code." }, + }; + + public override bool TryParseCommand(ICommandLineParser parser, string argument, out ICommandLineCommand command) + { + command = null; + + if ("convert".Equals(argument, StringComparison.OrdinalIgnoreCase)) + { + command = new ConvertCommand(this.ServiceProvider); + } + else if ("format".Equals(argument, StringComparison.OrdinalIgnoreCase)) + { + command = new FormatCommand(this.ServiceProvider); + } + + return command != null; + } + } +} diff --git a/src/wix/WixToolset.Converters/ConverterExtensionFactory.cs b/src/wix/WixToolset.Converters/ConverterExtensionFactory.cs new file mode 100644 index 00000000..d4f480aa --- /dev/null +++ b/src/wix/WixToolset.Converters/ConverterExtensionFactory.cs @@ -0,0 +1,30 @@ +// 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.Converters +{ + using System; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + + internal class ConverterExtensionFactory : IExtensionFactory + { + public ConverterExtensionFactory(IServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + } + + private IServiceProvider ServiceProvider { get; } + + public bool TryCreateExtension(Type extensionType, out object extension) + { + extension = null; + + if (extensionType == typeof(IExtensionCommandLine)) + { + extension = new ConverterExtensionCommandLine(this.ServiceProvider); + } + + return extension != null; + } + } +} diff --git a/src/wix/WixToolset.Converters/FixupCommandBase.cs b/src/wix/WixToolset.Converters/FixupCommandBase.cs new file mode 100644 index 00000000..21282d07 --- /dev/null +++ b/src/wix/WixToolset.Converters/FixupCommandBase.cs @@ -0,0 +1,288 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Threading; + using System.Threading.Tasks; + using System.Xml; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + internal abstract class FixupCommandBase : ICommandLineCommand + { + protected FixupCommandBase() + { + this.IndentationAmount = 4; // default indentation amount + this.ErrorsAsWarnings = new HashSet(); + this.ExemptFiles = new HashSet(); + this.IgnoreErrors = new HashSet(); + this.SearchPatternResults = new HashSet(); + this.SearchPatterns = new List(); + } + + public bool ShowLogo { get; private set; } + + public bool StopParsing { get; private set; } + + protected bool ShowHelp { get; set; } + + protected CustomTableTarget CustomTableSetting { get; set; } + + protected bool DryRun { get; set; } + + protected HashSet ErrorsAsWarnings { get; } + + protected HashSet IgnoreErrors { get; } + + protected HashSet ExemptFiles { get; } + + protected int IndentationAmount { get; set; } + + protected bool Recurse { get; set; } + + private HashSet SearchPatternResults { get; } + + private List SearchPatterns { get; } + + private string SettingsFile1 { get; set; } + + private string SettingsFile2 { get; set; } + + public bool TryParseArgument(ICommandLineParser parser, string argument) + { + if (!parser.IsSwitch(argument)) + { + this.SearchPatterns.Add(argument); + return true; + } + + var parameter = argument.Substring(1); + switch (parameter.ToLowerInvariant()) + { + case "?": + case "h": + case "-help": + this.ShowHelp = true; + this.ShowLogo = true; + this.StopParsing = true; + return true; + + case "-custom-table": + var customTableSetting = parser.GetNextArgumentOrError(argument); + switch (customTableSetting) + { + case "bundle": + this.CustomTableSetting = CustomTableTarget.Bundle; + break; + case "msi": + this.CustomTableSetting = CustomTableTarget.Msi; + break; + default: + parser.ReportErrorArgument(argument); + break; + } + return true; + + case "n": + case "-dry-run": + this.DryRun = true; + return true; + + case "nologo": + case "-nologo": + this.ShowLogo = false; + return true; + + case "s": + case "r": + case "-recurse": + case "-recursive": + this.Recurse = true; + return true; + + default: // other parameters + if (parameter.StartsWith("set1", StringComparison.Ordinal)) + { + this.SettingsFile1 = parameter.Substring(4); + return true; + } + else if (parameter.StartsWith("set2", StringComparison.Ordinal)) + { + this.SettingsFile2 = parameter.Substring(4); + return true; + } + else if (parameter.StartsWith("indent:", StringComparison.Ordinal)) + { + try + { + this.IndentationAmount = Convert.ToInt32(parameter.Substring(7)); + } + catch + { + parser.ReportErrorArgument(parameter); // $"Invalid numeric argument: {parameter}"; + } + return true; + } + + return false; + } + } + + public abstract Task ExecuteAsync(CancellationToken cancellationToken); + + protected void ParseSettings(string defaultSettingsFile) + { + // parse the settings if any were specified + if (null != this.SettingsFile1 || null != this.SettingsFile2) + { + this.ParseSettingsFiles(this.SettingsFile1, this.SettingsFile2); + } + else + { + if (File.Exists(defaultSettingsFile)) + { + this.ParseSettingsFiles(defaultSettingsFile, null); + } + } + } + + protected int Inspect(Func inspector, CancellationToken cancellationToken) + { + var errors = this.InspectSubDirectories(inspector, Path.GetFullPath("."), cancellationToken); + + foreach (var searchPattern in this.SearchPatterns) + { + if (!this.SearchPatternResults.Contains(searchPattern)) + { + Console.Error.WriteLine("Could not find file \"{0}\"", searchPattern); + errors++; + } + } + + return errors; + } + + /// + /// Inspect sub-directories. + /// + /// + /// The directory whose sub-directories will be inspected. + /// + /// The number of errors that were found. + private int InspectSubDirectories(Func inspector, string directory, CancellationToken cancellationToken) + { + var errors = 0; + + foreach (var searchPattern in this.SearchPatterns) + { + foreach (var sourceFilePath in GetFiles(directory, searchPattern)) + { + cancellationToken.ThrowIfCancellationRequested(); + + var file = new FileInfo(sourceFilePath); + + if (!this.ExemptFiles.Contains(file.Name.ToUpperInvariant())) + { + this.SearchPatternResults.Add(searchPattern); + errors += inspector(file.FullName, !this.DryRun); + } + } + } + + if (this.Recurse) + { + foreach (var childDirectoryPath in Directory.GetDirectories(directory)) + { + errors += this.InspectSubDirectories(inspector, childDirectoryPath, cancellationToken); + } + } + + return errors; + } + + /// + /// Parse the primary and secondary settings files. + /// + /// The primary settings file. + /// The secondary settings file. + private void ParseSettingsFiles(string localSettingsFile1, string localSettingsFile2) + { + if (null == localSettingsFile1 && null != localSettingsFile2) + { + throw new ArgumentException("Cannot specify a secondary settings file (set2) without a primary settings file (set1).", nameof(localSettingsFile2)); + } + + var settingsFile = localSettingsFile1; + while (null != settingsFile) + { + var doc = new XmlDocument(); + doc.Load(settingsFile); + + // get the types of tests that will have their errors displayed as warnings + var testsIgnoredElements = doc.SelectNodes("/Settings/IgnoreErrors/Test"); + foreach (XmlElement test in testsIgnoredElements) + { + var key = test.GetAttribute("Id"); + this.IgnoreErrors.Add(key); + } + + // get the types of tests that will have their errors displayed as warnings + var testsAsWarningsElements = doc.SelectNodes("/Settings/ErrorsAsWarnings/Test"); + foreach (XmlElement test in testsAsWarningsElements) + { + var key = test.GetAttribute("Id"); + this.ErrorsAsWarnings.Add(key); + } + + // get the exempt files + var localExemptFiles = doc.SelectNodes("/Settings/ExemptFiles/File"); + foreach (XmlElement file in localExemptFiles) + { + var key = file.GetAttribute("Name").ToUpperInvariant(); + this.ExemptFiles.Add(key); + } + + settingsFile = localSettingsFile2; + localSettingsFile2 = null; + } + } + + /// + /// Get the files that match a search path pattern. + /// + /// The base directory at which to begin the search. + /// The search path pattern. + /// The files matching the pattern. + private static string[] GetFiles(string baseDir, string searchPath) + { + // convert alternate directory separators to the standard one + var filePath = searchPath.Replace(Path.AltDirectorySeparatorChar, Path.DirectorySeparatorChar); + var lastSeparator = filePath.LastIndexOf(Path.DirectorySeparatorChar); + string[] files = null; + + try + { + if (0 > lastSeparator) + { + files = Directory.GetFiles(baseDir, filePath); + } + else // found directory separator + { + var searchPattern = filePath.Substring(lastSeparator + 1); + + files = Directory.GetFiles(filePath.Substring(0, lastSeparator + 1), searchPattern); + } + } + catch (DirectoryNotFoundException) + { + // don't let this function throw the DirectoryNotFoundException. (this exception + // occurs for non-existant directories and invalid characters in the searchPattern) + } + + return files; + } + } +} diff --git a/src/wix/WixToolset.Converters/FormatCommand.cs b/src/wix/WixToolset.Converters/FormatCommand.cs new file mode 100644 index 00000000..0861fc51 --- /dev/null +++ b/src/wix/WixToolset.Converters/FormatCommand.cs @@ -0,0 +1,60 @@ +// 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.Converters +{ + using System; + using System.Threading; + using System.Threading.Tasks; + using WixToolset.Extensibility.Services; + + internal class FormatCommand : FixupCommandBase + { + private const string SettingsFileDefault = "wix.format.settings.xml"; + + public FormatCommand(IServiceProvider serviceProvider) + { + this.Messaging = serviceProvider.GetService(); + } + + private IMessaging Messaging { get; } + + public override Task ExecuteAsync(CancellationToken cancellationToken) + { + if (this.ShowHelp) + { + DisplayHelp(); + return Task.FromResult(-1); + } + + var converter = new WixConverter(this.Messaging, this.IndentationAmount, this.ErrorsAsWarnings, this.IgnoreErrors); + + this.ParseSettings(SettingsFileDefault); + + var errors = base.Inspect(Inspector, cancellationToken); + + return Task.FromResult(errors); + + int Inspector(string file, bool fix) + { + return converter.FormatFile(file, fix); + } + } + + private static void DisplayHelp() + { + Console.WriteLine(); + Console.WriteLine("Usage: wix format [options] sourceFile [sourceFile ...]"); + Console.WriteLine(); + Console.WriteLine("Options:"); + Console.WriteLine(" -h|--help Show command line help."); + Console.WriteLine(" --nologo Suppress displaying the logo information."); + Console.WriteLine(" -n|--dry-run Only display errors, do not update files."); + Console.WriteLine(" -r|--recurse Search for matching files in current dir and subdirs."); + Console.WriteLine(" -set1 Primary settings file."); + Console.WriteLine(" -set2 Secondary settings file (overrides primary)."); + Console.WriteLine(" -indent: Indentation multiple (overrides default of 4)."); + Console.WriteLine(); + Console.WriteLine(" sourceFile may use wildcards like *.wxs"); + } + } +} diff --git a/src/wix/WixToolset.Converters/WixConverter.cs b/src/wix/WixToolset.Converters/WixConverter.cs new file mode 100644 index 00000000..e42d0605 --- /dev/null +++ b/src/wix/WixToolset.Converters/WixConverter.cs @@ -0,0 +1,2435 @@ +// 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.Converters +{ + using System; + using System.Collections.Generic; + using System.Globalization; + using System.IO; + using System.Linq; + using System.Text; + using System.Text.RegularExpressions; + using System.Xml; + using System.Xml.Linq; + using WixToolset.Data; + using WixToolset.Data.WindowsInstaller; + using WixToolset.Extensibility.Services; + + /// + /// How to convert CustomTable elements. + /// + public enum CustomTableTarget + { + /// + /// Ambiguous elements will be left alone. + /// + Unknown, + + /// + /// Use CustomTable, CustomTableRef, and Unreal. + /// + Msi, + + /// + /// Use BundleCustomData and BundleCustomDataRef. + /// + Bundle, + } + + /// + /// WiX source code converter. + /// + public sealed class WixConverter + { + private enum ConvertOperation + { + Convert, + Format, + } + + private static readonly Regex AddPrefix = new Regex(@"^[^a-zA-Z_]", RegexOptions.Compiled); + private static readonly Regex IllegalIdentifierCharacters = new Regex(@"[^A-Za-z0-9_\.]|\.{2,}", RegexOptions.Compiled); // non 'words' and assorted valid characters + + private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n". + private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; + private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; + private static readonly XNamespace WixBalNamespace = "http://wixtoolset.org/schemas/v4/wxs/bal"; + private static readonly XNamespace WixDependencyNamespace = "http://wixtoolset.org/schemas/v4/wxs/dependency"; + private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; + private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall"; + + private static readonly XName AdminExecuteSequenceElementName = WixNamespace + "AdminExecuteSequence"; + private static readonly XName AdminUISequenceSequenceElementName = WixNamespace + "AdminUISequence"; + private static readonly XName AdvertiseExecuteSequenceElementName = WixNamespace + "AdvertiseExecuteSequence"; + private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence"; + private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence"; + private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication"; + private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll"; + private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef"; + private static readonly XName ApprovedExeForElevationElementName = WixNamespace + "ApprovedExeForElevation"; + private static readonly XName BundleAttributeElementName = WixNamespace + "BundleAttribute"; + private static readonly XName BundleAttributeDefinitionElementName = WixNamespace + "BundleAttributeDefinition"; + private static readonly XName BundleCustomDataElementName = WixNamespace + "BundleCustomData"; + private static readonly XName BundleCustomDataRefElementName = WixNamespace + "BundleCustomDataRef"; + private static readonly XName BundleElementElementName = WixNamespace + "BundleElement"; + private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; + private static readonly XName CustomTableRefElementName = WixNamespace + "CustomTableRef"; + private static readonly XName CatalogElementName = WixNamespace + "Catalog"; + private static readonly XName ColumnElementName = WixNamespace + "Column"; + private static readonly XName ComponentElementName = WixNamespace + "Component"; + private static readonly XName ControlElementName = WixNamespace + "Control"; + private static readonly XName ConditionElementName = WixNamespace + "Condition"; + private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; + private static readonly XName DataElementName = WixNamespace + "Data"; + private static readonly XName OldProvidesElementName = WixDependencyNamespace + "Provides"; + private static readonly XName OldRequiresElementName = WixDependencyNamespace + "Requires"; + private static readonly XName OldRequiresRefElementName = WixDependencyNamespace + "RequiresRef"; + private static readonly XName DirectoryElementName = WixNamespace + "Directory"; + private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer"; + private static readonly XName ErrorElementName = WixNamespace + "Error"; + private static readonly XName FeatureElementName = WixNamespace + "Feature"; + private static readonly XName FileElementName = WixNamespace + "File"; + private static readonly XName FragmentElementName = WixNamespace + "Fragment"; + private static readonly XName FirewallRemoteAddressElementName = WixFirewallNamespace + "RemoteAddress"; + private static readonly XName LaunchElementName = WixNamespace + "Launch"; + private static readonly XName LevelElementName = WixNamespace + "Level"; + private static readonly XName ExePackageElementName = WixNamespace + "ExePackage"; + private static readonly XName ExePackagePayloadElementName = WixNamespace + "ExePackagePayload"; + private static readonly XName ModuleElementName = WixNamespace + "Module"; + private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage"; + private static readonly XName MspPackageElementName = WixNamespace + "MspPackage"; + private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage"; + private static readonly XName MsuPackagePayloadElementName = WixNamespace + "MsuPackagePayload"; + private static readonly XName PackageElementName = WixNamespace + "Package"; + private static readonly XName PayloadElementName = WixNamespace + "Payload"; + private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx"; + private static readonly XName ProductElementName = WixNamespace + "Product"; + private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; + private static readonly XName PropertyRefElementName = WixNamespace + "PropertyRef"; + private static readonly XName PublishElementName = WixNamespace + "Publish"; + private static readonly XName ProvidesElementName = WixNamespace + "Provides"; + private static readonly XName RequiresElementName = WixNamespace + "Requires"; + private static readonly XName RequiresRefElementName = WixNamespace + "RequiresRef"; + private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; + private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; + private static readonly XName RegistryKeyElementName = WixNamespace + "RegistryKey"; + private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; + private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege"; + private static readonly XName RowElementName = WixNamespace + "Row"; + private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument"; + private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory"; + private static readonly XName SetPropertyElementName = WixNamespace + "SetProperty"; + private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; + private static readonly XName SoftwareTagElementName = WixNamespace + "SoftwareTag"; + private static readonly XName SoftwareTagRefElementName = WixNamespace + "SoftwareTagRef"; + private static readonly XName StandardDirectoryElementName = WixNamespace + "StandardDirectory"; + private static readonly XName TagElementName = XNamespace.None + "Tag"; + private static readonly XName TagRefElementName = XNamespace.None + "TagRef"; + private static readonly XName TextElementName = WixNamespace + "Text"; + private static readonly XName UITextElementName = WixNamespace + "UIText"; + private static readonly XName VariableElementName = WixNamespace + "Variable"; + private static readonly XName VerbElementName = WixNamespace + "Verb"; + private static readonly XName BalUseUILanguagesName = WixBalNamespace + "UseUILanguages"; + private static readonly XName BalStandardBootstrapperApplicationName = WixBalNamespace + "WixStandardBootstrapperApplication"; + private static readonly XName BalManagedBootstrapperApplicationHostName = WixBalNamespace + "WixManagedBootstrapperApplicationHost"; + private static readonly XName BalOldDotNetCoreBootstrapperApplicationName = WixBalNamespace + "WixDotNetCoreBootstrapperApplication"; + private static readonly XName BalNewDotNetCoreBootstrapperApplicationName = WixBalNamespace + "WixDotNetCoreBootstrapperApplicationHost"; + private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; + private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; + private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch"; + private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; + private static readonly XName CustomActionElementName = WixNamespace + "CustomAction"; + private static readonly XName CustomActionRefElementName = WixNamespace + "CustomActionRef"; + private static readonly XName PropertyElementName = WixNamespace + "Property"; + private static readonly XName Wix4ElementName = WixNamespace + "Wix"; + private static readonly XName Wix3ElementName = Wix3Namespace + "Wix"; + private static readonly XName WixElementWithoutNamespaceName = XNamespace.None + "Wix"; + private static readonly XName Include4ElementName = WixNamespace + "Include"; + private static readonly XName Include3ElementName = Wix3Namespace + "Include"; + private static readonly XName IncludeElementWithoutNamespaceName = XNamespace.None + "Include"; + private static readonly XName SummaryInformationElementName = WixNamespace + "SummaryInformation"; + private static readonly XName MediaTemplateElementName = WixNamespace + "MediaTemplate"; + + private static readonly XName DependencyCheckAttributeName = WixDependencyNamespace + "Check"; + private static readonly XName DependencyEnforceAttributeName = WixDependencyNamespace + "Enforce"; + + private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() + { + { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, + { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, + { "http://schemas.microsoft.com/wix/DependencyExtension", WixDependencyNamespace }, + { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, + { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, + { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, + { "http://schemas.microsoft.com/wix/IIsExtension", "http://wixtoolset.org/schemas/v4/wxs/iis" }, + { "http://schemas.microsoft.com/wix/MsmqExtension", "http://wixtoolset.org/schemas/v4/wxs/msmq" }, + { "http://schemas.microsoft.com/wix/NetFxExtension", "http://wixtoolset.org/schemas/v4/wxs/netfx" }, + { "http://schemas.microsoft.com/wix/PSExtension", "http://wixtoolset.org/schemas/v4/wxs/powershell" }, + { "http://schemas.microsoft.com/wix/SqlExtension", "http://wixtoolset.org/schemas/v4/wxs/sql" }, + { "http://schemas.microsoft.com/wix/TagExtension", XNamespace.None }, + { "http://schemas.microsoft.com/wix/UtilExtension", WixUtilNamespace }, + { "http://schemas.microsoft.com/wix/VSExtension", "http://wixtoolset.org/schemas/v4/wxs/vs" }, + { "http://wixtoolset.org/schemas/thmutil/2010", "http://wixtoolset.org/schemas/v4/thmutil" }, + { "http://schemas.microsoft.com/wix/2009/Lux", "http://wixtoolset.org/schemas/v4/lux" }, + { "http://schemas.microsoft.com/wix/2006/wi", "http://wixtoolset.org/schemas/v4/wxs" }, + { "http://schemas.microsoft.com/wix/2006/localization", "http://wixtoolset.org/schemas/v4/wxl" }, + { "http://schemas.microsoft.com/wix/2006/libraries", "http://wixtoolset.org/schemas/v4/wixlib" }, + { "http://schemas.microsoft.com/wix/2006/objects", "http://wixtoolset.org/schemas/v4/wixobj" }, + { "http://schemas.microsoft.com/wix/2006/outputs", "http://wixtoolset.org/schemas/v4/wixout" }, + { "http://schemas.microsoft.com/wix/2007/pdbs", "http://wixtoolset.org/schemas/v4/wixpdb" }, + { "http://schemas.microsoft.com/wix/2003/04/actions", "http://wixtoolset.org/schemas/v4/wi/actions" }, + { "http://schemas.microsoft.com/wix/2006/tables", "http://wixtoolset.org/schemas/v4/wi/tables" }, + { "http://schemas.microsoft.com/wix/2006/WixUnit", "http://wixtoolset.org/schemas/v4/wixunit" }, + }; + + private readonly Dictionary> ConvertElementMapping; + private readonly Regex DeprecatedPrefixRegex = new Regex(@"(?<=(^|[^\$])(\$\$)*)\$(?=\(loc\.[^.].*\))", + RegexOptions.Compiled | RegexOptions.CultureInvariant | RegexOptions.ExplicitCapture); + + /// + /// Instantiate a new Converter class. + /// + /// + /// Indentation value to use when validating leading whitespace. + /// Test errors to display as warnings. + /// Test errors to ignore. + /// How to convert CustomTable elements. + public WixConverter(IMessaging messaging, int indentationAmount, IEnumerable errorsAsWarnings = null, IEnumerable ignoreErrors = null, CustomTableTarget customTableTarget = CustomTableTarget.Unknown) + { + this.ConvertElementMapping = new Dictionary> + { + { WixConverter.AdminExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.AdminUISequenceSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.AdvertiseExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.InstallUISequenceSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement }, + { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement }, + { WixConverter.BootstrapperApplicationRefElementName, this.ConvertBootstrapperApplicationRefElement }, + { WixConverter.ApprovedExeForElevationElementName, this.ConvertApprovedExeForElevationElement }, + { WixConverter.CatalogElementName, this.ConvertCatalogElement }, + { WixConverter.ColumnElementName, this.ConvertColumnElement }, + { WixConverter.ComponentElementName, this.ConvertComponentElement }, + { WixConverter.ControlElementName, this.ConvertControlElement }, + { WixConverter.CustomActionElementName, this.ConvertCustomActionElement }, + { WixConverter.CustomTableElementName, this.ConvertCustomTableElement }, + { WixConverter.DataElementName, this.ConvertDataElement }, + { WixConverter.DirectoryElementName, this.ConvertDirectoryElement }, + { WixConverter.FeatureElementName, this.ConvertFeatureElement }, + { WixConverter.FileElementName, this.ConvertFileElement }, + { WixConverter.FragmentElementName, this.ConvertFragmentElement }, + { WixConverter.FirewallRemoteAddressElementName, this.ConvertFirewallRemoteAddressElement }, + { WixConverter.EmbeddedChainerElementName, this.ConvertEmbeddedChainerElement }, + { WixConverter.ErrorElementName, this.ConvertErrorElement }, + { WixConverter.ExePackageElementName, this.ConvertExePackageElement }, + { WixConverter.ModuleElementName, this.ConvertModuleElement }, + { WixConverter.MsiPackageElementName, this.ConvertWindowsInstallerPackageElement }, + { WixConverter.MspPackageElementName, this.ConvertWindowsInstallerPackageElement }, + { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.OldProvidesElementName, this.ConvertProvidesElement }, + { WixConverter.OldRequiresElementName, this.ConvertRequiresElement }, + { WixConverter.OldRequiresRefElementName, this.ConvertRequiresRefElement }, + { WixConverter.PayloadElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, + { WixConverter.ProductElementName, this.ConvertProductElement }, + { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement }, + { WixConverter.PropertyRefElementName, this.ConvertPropertyRefElement }, + { WixConverter.PublishElementName, this.ConvertPublishElement }, + { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement }, + { WixConverter.RegistryKeyElementName, this.ConvertRegistryKeyElement }, + { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement }, + { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement }, + { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement }, + { WixConverter.CustomActionRefElementName, this.ConvertCustomActionRefElement }, + { WixConverter.ServiceArgumentElementName, this.ConvertServiceArgumentElement }, + { WixConverter.SetDirectoryElementName, this.ConvertSetDirectoryElement }, + { WixConverter.SetPropertyElementName, this.ConvertSetPropertyElement }, + { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, + { WixConverter.TagElementName, this.ConvertTagElement }, + { WixConverter.TagRefElementName, this.ConvertTagRefElement }, + { WixConverter.TextElementName, this.ConvertTextElement }, + { WixConverter.UITextElementName, this.ConvertUITextElement }, + { WixConverter.VariableElementName, this.ConvertVariableElement }, + { WixConverter.UtilCloseApplicationElementName, this.ConvertUtilCloseApplicationElementName }, + { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, + { WixConverter.UtilRegistrySearchName, this.ConvertUtilRegistrySearchElement }, + { WixConverter.UtilXmlConfigElementName, this.ConvertUtilXmlConfigElement }, + { WixConverter.PropertyElementName, this.ConvertPropertyElement }, + { WixConverter.WixElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, + { WixConverter.IncludeElementWithoutNamespaceName, this.ConvertElementWithoutNamespace }, + { WixConverter.VerbElementName, this.ConvertVerbElement }, + }; + + this.Messaging = messaging; + + this.IndentationAmount = indentationAmount; + + this.ErrorsAsWarnings = new HashSet(this.YieldConverterTypes(errorsAsWarnings)); + + this.IgnoreErrors = new HashSet(this.YieldConverterTypes(ignoreErrors)); + + this.CustomTableSetting = customTableTarget; + } + + private CustomTableTarget CustomTableSetting { get; } + + private int Errors { get; set; } + + private HashSet ErrorsAsWarnings { get; set; } + + private HashSet IgnoreErrors { get; set; } + + private IMessaging Messaging { get; } + + private int IndentationAmount { get; set; } + + private ConvertOperation Operation { get; set; } + + private string SourceFile { get; set; } + + private int SourceVersion { get; set; } + + /// + /// Convert a file. + /// + /// The file to convert. + /// Option to save the converted errors that are found. + /// The number of errors found. + public int ConvertFile(string sourceFile, bool saveConvertedFile) + { + var document = this.OpenSourceFile(sourceFile); + + if (document is null) + { + return 1; + } + + this.ConvertDocument(document); + + // Fix errors if requested and necessary. + if (saveConvertedFile && 0 < this.Errors) + { + this.SaveDocument(document); + } + + return this.Errors; + } + + /// + /// Convert a document. + /// + /// The document to convert. + /// The number of errors found. + public int ConvertDocument(XDocument document) + { + // Reset the instance info. + this.Errors = 0; + this.SourceVersion = 0; + this.Operation = ConvertOperation.Convert; + + // Remove the declaration. + if (null != document.Declaration + && this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) + { + document.Declaration = null; + TrimLeadingText(document); + } + + // Start converting the nodes at the top. + this.ConvertNodes(document.Nodes(), 0); + this.RemoveUnusedNamespaces(document.Root); + + return this.Errors; + } + + /// + /// Format a file. + /// + /// The file to format. + /// Option to save the format errors that are found. + /// The number of errors found. + public int FormatFile(string sourceFile, bool saveConvertedFile) + { + var document = this.OpenSourceFile(sourceFile); + + if (document is null) + { + return 1; + } + + this.FormatDocument(document); + + // Fix errors if requested and necessary. + if (saveConvertedFile && 0 < this.Errors) + { + this.SaveDocument(document); + } + + return this.Errors; + } + + /// + /// Format a document. + /// + /// The document to format. + /// The number of errors found. + public int FormatDocument(XDocument document) + { + // Reset the instance info. + this.Errors = 0; + this.SourceVersion = 0; + this.Operation = ConvertOperation.Format; + + // Remove the declaration. + if (null != document.Declaration + && this.OnError(ConverterTestType.DeclarationPresent, null, "This file contains an XML declaration on the first line.")) + { + document.Declaration = null; + TrimLeadingText(document); + } + + // Start converting the nodes at the top. + this.ConvertNodes(document.Nodes(), 0); + this.RemoveUnusedNamespaces(document.Root); + + return this.Errors; + } + + private XDocument OpenSourceFile(string sourceFile) + { + this.SourceFile = sourceFile; + + try + { + return XDocument.Load(this.SourceFile, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + } + catch (XmlException e) + { + this.OnError(ConverterTestType.XmlException, null, "The xml is invalid. Detail: '{0}'", e.Message); + } + + return null; + } + + private void SaveDocument(XDocument document) + { + var ignoreDeclarationError = this.IgnoreErrors.Contains(ConverterTestType.DeclarationPresent); + + try + { + using (var writer = XmlWriter.Create(this.SourceFile, new XmlWriterSettings { OmitXmlDeclaration = !ignoreDeclarationError })) + { + document.Save(writer); + } + } + catch (UnauthorizedAccessException) + { + this.OnError(ConverterTestType.UnauthorizedAccessException, null, "Could not write to file."); + } + } + + private void ConvertNodes(IEnumerable nodes, int level) + { + // Note we operate on a copy of the node list since we may + // remove some whitespace nodes during this processing. + foreach (var node in nodes.ToList()) + { + if (node is XText text) + { + if (null != text.Value) + { + if (this.TryFixDeprecatedLocalizationPrefixes(node, text.Value, out var newValue, ConverterTestType.DeprecatedLocalizationVariablePrefixInTextValue)) + { + text.Value = newValue; + } + } + if (!String.IsNullOrWhiteSpace(text.Value)) + { + text.Value = text.Value.Trim(); + } + else if (node.NextNode is XCData cdata) + { + this.EnsurePrecedingWhitespaceRemoved(text, node, ConverterTestType.WhitespacePrecedingNodeWrong); + } + else if (node.NextNode is XElement element) + { + this.EnsurePrecedingWhitespaceCorrect(text, node, level, ConverterTestType.WhitespacePrecedingNodeWrong); + } + else if (node.NextNode is null) // this is the space before the close element + { + if (node.PreviousNode is null || node.PreviousNode is XCData) + { + this.EnsurePrecedingWhitespaceRemoved(text, node.Parent, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + else if (level == 0) // root element's close tag + { + this.EnsurePrecedingWhitespaceCorrect(text, node, 0, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + else + { + this.EnsurePrecedingWhitespaceCorrect(text, node, level - 1, ConverterTestType.WhitespacePrecedingEndElementWrong); + } + } + } + else if (node is XElement element) + { + this.ConvertElement(element); + + var before = element.Nodes().ToList(); + + this.ConvertNodes(before, level + 1); + + // If any nodes were added during the processing of the children, + // ensure those added children get processed as well. + var added = element.Nodes().Except(before).ToList(); + + if (added.Any()) + { + this.ConvertNodes(added, level + 1); + } + } + } + } + + private bool TryFixDeprecatedLocalizationPrefixes(XNode node, string value, out string newValue, ConverterTestType testType) + { + newValue = this.DeprecatedPrefixRegex.Replace(value, "!"); + + if (object.ReferenceEquals(newValue, value)) + { + return false; + } + + var message = testType == ConverterTestType.DeprecatedLocalizationVariablePrefixInTextValue ? "The prefix on the localization variable in the inner text is incorrect." : "The prefix on the localization variable in the attribute value is incorrect."; + + return this.OnError(testType, node, message); + } + + private void EnsurePrecedingWhitespaceCorrect(XText whitespace, XNode node, int level, ConverterTestType testType) + { + if (!WixConverter.LeadingWhitespaceValid(this.IndentationAmount, level, whitespace.Value)) + { + var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; + + if (this.OnError(testType, node, message)) + { + WixConverter.FixupWhitespace(this.IndentationAmount, level, whitespace); + } + } + } + + private void EnsurePrecedingWhitespaceRemoved(XText whitespace, XNode node, ConverterTestType testType) + { + if (!String.IsNullOrEmpty(whitespace.Value) && whitespace.NodeType != XmlNodeType.CDATA) + { + var message = testType == ConverterTestType.WhitespacePrecedingEndElementWrong ? "The whitespace preceding this end element is incorrect." : "The whitespace preceding this node is incorrect."; + + if (this.OnError(testType, node, message)) + { + whitespace.Remove(); + } + } + } + + private void ConvertElement(XElement element) + { + var deprecatedToUpdatedNamespaces = new Dictionary(); + + foreach (var attribute in element.Attributes()) + { + if (attribute.IsNamespaceDeclaration) + { + // Gather any deprecated namespaces, then update this element tree based on those deprecations. + var declaration = attribute; + + if (element.Name == Wix3ElementName || element.Name == Include3ElementName) + { + this.SourceVersion = 3; + } + else if (element.Name == Wix4ElementName || element.Name == Include4ElementName) + { + this.SourceVersion = 4; + } + + if (WixConverter.OldToNewNamespaceMapping.TryGetValue(declaration.Value, out var ns)) + { + if (this.OnError(ConverterTestType.XmlnsValueWrong, declaration, "The namespace '{0}' is out of date. It must be '{1}'.", declaration.Value, ns.NamespaceName)) + { + deprecatedToUpdatedNamespaces.Add(declaration.Value, ns); + } + } + } + else + { + if (null != attribute.Value) + { + if (this.TryFixDeprecatedLocalizationPrefixes(element, attribute.Value, out var newValue, ConverterTestType.DeprecatedLocalizationVariablePrefixInAttributeValue)) + { + attribute.Value = newValue; + } + } + } + } + + if (deprecatedToUpdatedNamespaces.Any()) + { + WixConverter.UpdateElementsWithDeprecatedNamespaces(element.DescendantsAndSelf(), deprecatedToUpdatedNamespaces); + } + + // Apply any specialized conversion actions. + if (this.ConvertElementMapping.TryGetValue(element.Name, out var convert)) + { + convert(element); + } + } + + private void ConvertBootstrapperApplicationElement(XElement element) + { + var xUseUILanguages = element.Attribute(BalUseUILanguagesName); + if (xUseUILanguages != null && + this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior.")) + { + xUseUILanguages.Remove(); + } + + var xBADll = element.Elements(BootstrapperApplicationDllElementName).FirstOrDefault(); + if (xBADll == null) + { + xBADll = this.CreateBootstrapperApplicationDllElement(element); + + if (xBADll != null) + { + element.Add(Environment.NewLine); + element.Add(xBADll); + element.Add(Environment.NewLine); + } + } + } + + private XElement CreateBootstrapperApplicationDllElement(XElement element) + { + XElement xBADll = null; + var xSource = element.Attribute("SourceFile"); + var xDpiAwareness = element.Attribute("DpiAwareness"); + + if (xSource != null) + { + if (xBADll != null || CreateBADllElement(element, out xBADll)) + { + MoveAttribute(element, "SourceFile", xBADll); + MoveAttribute(element, "Name", xBADll); + } + } + else if (xDpiAwareness != null || this.SourceVersion < 4) // older code might be relying on old behavior of first Payload element being the BA dll. + { + var xFirstChild = element.Elements().FirstOrDefault(); + if (xFirstChild?.Name == PayloadElementName) + { + if (xBADll != null || CreateBADllElement(element, out xBADll)) + { + var attributes = xFirstChild.Attributes().ToList(); + xFirstChild.Remove(); + + foreach (var attribute in attributes) + { + xBADll.Add(attribute); + } + } + } + else + { + this.OnError(ConverterTestType.BootstrapperApplicationDllRequired, element, "The new BootstrapperApplicationDll element is required but could not be added automatically since the bootstrapper application dll was not directly specified."); + } + } + + if (xDpiAwareness != null) + { + if (xBADll != null || CreateBADllElement(element, out xBADll)) + { + MoveAttribute(element, "DpiAwareness", xBADll); + } + } + else if (this.SourceVersion < 4 && xBADll != null && + this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplicationDll DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default")) + { + xBADll.Add(new XAttribute("DpiAwareness", "unaware")); + } + + return xBADll; + + bool CreateBADllElement(XObject node, out XElement xCreatedBADll) + { + var create = this.OnError(ConverterTestType.BootstrapperApplicationDll, node, "The bootstrapper application dll is now specified in the BootstrapperApplicationDll element."); + xCreatedBADll = create ? new XElement(BootstrapperApplicationDllElementName) : null; + return create; + } + } + + private void ConvertBootstrapperApplicationRefElement(XElement element) + { + var xUseUILanguages = element.Attribute(BalUseUILanguagesName); + if (xUseUILanguages != null && + this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior.")) + { + xUseUILanguages.Remove(); + } + + var xId = element.Attribute("Id"); + if (xId != null) + { + XName balBAName = null; + XName oldBalBAName = null; + string theme = null; + + switch (xId.Value) + { + case "WixStandardBootstrapperApplication.RtfLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "rtfLicense"; + break; + case "WixStandardBootstrapperApplication.RtfLargeLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "rtfLargeLicense"; + break; + case "WixStandardBootstrapperApplication.HyperlinkLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "hyperlinkLicense"; + break; + case "WixStandardBootstrapperApplication.HyperlinkLargeLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "hyperlinkLargeLicense"; + break; + case "WixStandardBootstrapperApplication.HyperlinkSidebarLicense": + balBAName = BalStandardBootstrapperApplicationName; + theme = "hyperlinkSidebarLicense"; + break; + case "WixStandardBootstrapperApplication.Foundation": + balBAName = BalStandardBootstrapperApplicationName; + theme = "none"; + break; + case "ManagedBootstrapperApplicationHost": + case "ManagedBootstrapperApplicationHost.RtfLicense": + balBAName = BalManagedBootstrapperApplicationHostName; + theme = "standard"; + break; + case "ManagedBootstrapperApplicationHost.Minimal": + case "ManagedBootstrapperApplicationHost.RtfLicense.Minimal": + case "ManagedBootstrapperApplicationHost.Foundation": + balBAName = BalManagedBootstrapperApplicationHostName; + theme = "none"; + break; + case "DotNetCoreBootstrapperApplicationHost": + case "DotNetCoreBootstrapperApplicationHost.RtfLicense": + balBAName = BalNewDotNetCoreBootstrapperApplicationName; + oldBalBAName = BalOldDotNetCoreBootstrapperApplicationName; + theme = "standard"; + break; + case "DotNetCoreBootstrapperApplicationHost.Minimal": + case "DotNetCoreBootstrapperApplicationHost.RtfLicense.Minimal": + case "DotNetCoreBootstrapperApplicationHost.Foundation": + balBAName = BalNewDotNetCoreBootstrapperApplicationName; + oldBalBAName = BalOldDotNetCoreBootstrapperApplicationName; + theme = "none"; + break; + } + + if (balBAName != null && theme != null && + this.OnError(ConverterTestType.BalBootstrapperApplicationRefToElement, element, "Built-in bootstrapper applications must be referenced through their custom element")) + { + element.Name = BootstrapperApplicationElementName; + xId.Remove(); + this.ConvertBalBootstrapperApplicationRef(element, theme, balBAName, oldBalBAName); + } + } + } + + private void ConvertApprovedExeForElevationElement(XElement element) + { + this.RenameWin64ToBitness(element); + } + + private void ConvertBalBootstrapperApplicationRef(XElement element, string theme, XName balBAElementName, XName oldBalBAElementName = null) + { + var xBalBa = element.Element(oldBalBAElementName ?? balBAElementName); + if (xBalBa == null) + { + xBalBa = new XElement(balBAElementName); + element.Add(Environment.NewLine); + element.Add(xBalBa); + element.Add(Environment.NewLine); + } + else if (oldBalBAElementName != null) + { + xBalBa.Name = BalNewDotNetCoreBootstrapperApplicationName; + } + + if (theme != "standard") + { + xBalBa.Add(new XAttribute("Theme", theme)); + } + } + + private void ConvertCatalogElement(XElement element) + { + if (this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The Catalog element is obsolete. Signature validation is no longer supported. The element will be removed.")) + { + element.Remove(); + } + } + + private void ConvertColumnElement(XElement element) + { + var category = element.Attribute("Category"); + if (category != null) + { + var camelCaseValue = LowercaseFirstChar(category.Value); + if (category.Value != camelCaseValue && + this.OnError(ConverterTestType.ColumnCategoryCamelCase, element, "The CustomTable Category attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", category.Name)) + { + category.Value = camelCaseValue; + } + } + + var modularization = element.Attribute("Modularize"); + if (modularization != null) + { + var camelCaseValue = LowercaseFirstChar(modularization.Value); + if (modularization.Value != camelCaseValue && + this.OnError(ConverterTestType.ColumnModularizeCamelCase, element, "The CustomTable Modularize attribute contains an incorrectly cased '{0}' value. Lowercase the first character instead.", modularization.Name)) + { + modularization.Value = camelCaseValue; + } + } + } + + private void ConvertCustomTableElement(XElement element) + { + var bootstrapperApplicationData = element.Attribute("BootstrapperApplicationData"); + if (bootstrapperApplicationData?.Value == "no") + { + if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) + { + bootstrapperApplicationData.Remove(); + } + } + else + { + if (element.Elements(ColumnElementName).Any() || bootstrapperApplicationData != null) + { + // Table definition + if (bootstrapperApplicationData != null) + { + switch (this.CustomTableSetting) + { + case CustomTableTarget.Bundle: + if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'BundleCustomData' element for Bundles.", bootstrapperApplicationData.Name)) + { + element.Name = WixConverter.BundleCustomDataElementName; + bootstrapperApplicationData.Remove(); + this.ConvertCustomTableElementToBundle(element); + } + break; + case CustomTableTarget.Msi: + if (this.OnError(ConverterTestType.BootstrapperApplicationDataDeprecated, element, "The CustomTable element contains deprecated '{0}' attribute. Use the 'Unreal' attribute instead.", bootstrapperApplicationData.Name)) + { + element.Add(new XAttribute("Unreal", bootstrapperApplicationData.Value)); + bootstrapperApplicationData.Remove(); + } + break; + default: + this.OnError(ConverterTestType.CustomTableNotAlwaysConvertable, element, "The CustomTable element contains deprecated '{0}' attribute so can't be converted. Use the 'Unreal' attribute for MSI. Use the 'BundleCustomData' element for Bundles. Use the --custom-table argument to force conversion to 'msi' or 'bundle'", bootstrapperApplicationData.Name); + break; + } + } + } + else + { + // Table ref + switch (this.CustomTableSetting) + { + case CustomTableTarget.Bundle: + if (this.OnError(ConverterTestType.CustomTableRef, element, "CustomTable elements that don't contain the table definition are now BundleCustomDataRef for Bundles.")) + { + element.Name = WixConverter.BundleCustomDataRefElementName; + this.ConvertCustomTableElementToBundle(element); + } + break; + case CustomTableTarget.Msi: + if (this.OnError(ConverterTestType.CustomTableRef, element, "CustomTable elements that don't contain the table definition are now CustomTableRef for MSI.")) + { + element.Name = WixConverter.CustomTableRefElementName; + } + break; + default: + this.OnError(ConverterTestType.CustomTableNotAlwaysConvertable, element, "The CustomTable element contains no 'Column' elements so can't be converted. Use the 'CustomTableRef' element for MSI. Use the 'BundleCustomDataRef' element for Bundles. Use the --custom-table argument to force conversion to 'msi' or 'bundle'"); + break; + } + } + } + } + + private void ConvertCustomTableElementToBundle(XElement element) + { + foreach (var xColumn in element.Elements(ColumnElementName)) + { + xColumn.Name = WixConverter.BundleAttributeDefinitionElementName; + + foreach (var xAttribute in xColumn.Attributes().ToList()) + { + if (xAttribute.Name.LocalName != "Id" && + (xAttribute.Name.Namespace == WixConverter.Wix3Namespace || + xAttribute.Name.Namespace == WixConverter.WixNamespace || + String.IsNullOrEmpty(xAttribute.Name.Namespace.NamespaceName))) + { + xAttribute.Remove(); + } + } + } + + foreach (var xRow in element.Elements(RowElementName)) + { + xRow.Name = WixConverter.BundleElementElementName; + + foreach (var xData in xRow.Elements(DataElementName)) + { + xData.Name = WixConverter.BundleAttributeElementName; + + var xColumn = xData.Attribute("Column"); + if (xColumn != null) + { + xData.Add(new XAttribute("Id", xColumn.Value)); + xColumn.Remove(); + } + + this.ConvertInnerTextToAttribute(xData, "Value"); + } + } + } + + private void ConvertControlElement(XElement element) + { + var remove = new List(); + + foreach (var xCondition in element.Elements(ConditionElementName)) + { + var action = UppercaseFirstChar(xCondition.Attribute("Action")?.Value); + if (!String.IsNullOrEmpty(action) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}Condition' attribute instead.", xCondition.Name.LocalName, action)) + { + element.Add(new XAttribute(action + "Condition", text)); + remove.Add(xCondition); + } + } + + for (var i = remove.Count - 1; i >= 0; i--) + { + remove[i].Remove(); + } + } + + private void ConvertComponentElement(XElement element) + { + var guid = element.Attribute("Guid"); + if (guid != null && guid.Value == "*") + { + if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Component Guid attribute is unnecessary. Remove the attribute to remove the redundancy.")) + { + guid.Remove(); + } + } + + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + if (TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) + { + element.Add(new XAttribute("Condition", text)); + xCondition.Remove(); + } + } + + this.RenameWin64ToBitness(element); + } + + private void ConvertDirectoryElement(XElement element) + { + if (null == element.Attribute("Name")) + { + var attribute = element.Attribute("ShortName"); + if (null != attribute) + { + var shortName = attribute.Value; + if (this.OnError(ConverterTestType.AssignDirectoryNameFromShortName, element, "The directory ShortName attribute is being renamed to Name since Name wasn't specified for value '{0}'", shortName)) + { + element.Add(new XAttribute("Name", shortName)); + attribute.Remove(); + } + } + } + + var id = element.Attribute("Id")?.Value; + + if (id == "TARGETDIR" && + this.OnError(ConverterTestType.TargetDirDeprecated, element, "The TARGETDIR directory should not longer be explicitly defined. Remove the Directory element with Id attribute 'TARGETDIR'.")) + { + var parentElement = element.Parent; + + element.Remove(); + + if (parentElement.FirstNode is XText text && String.IsNullOrWhiteSpace(text.Value)) + { + parentElement.FirstNode.Remove(); + } + + foreach (var child in element.Nodes()) + { + parentElement.Add(child); + } + + element.RemoveAll(); + + if (parentElement.FirstNode is XText textAgain && String.IsNullOrWhiteSpace(textAgain.Value)) + { + parentElement.FirstNode.Remove(); + } + } + else if (id != null && + WindowsInstallerStandard.IsStandardDirectory(id) && + this.OnError(ConverterTestType.DefiningStandardDirectoryDeprecated, element, "Standard directories such as '{0}' should no longer be defined using the Directory element. Use the StandardDirectory element instead.", id)) + { + element.Name = StandardDirectoryElementName; + + foreach (var attrib in element.Attributes().Where(a => a.Name.LocalName != "Id").ToList()) + { + attrib.Remove(); + } + } + } + + private void ConvertFeatureElement(XElement element) + { + var xAbsent = element.Attribute("Absent"); + if (xAbsent != null && + this.OnError(ConverterTestType.FeatureAbsentAttributeReplaced, element, "The Feature element's Absent attribute has been replaced with the AllowAbsent attribute. Use the 'AllowAbsent' attribute instead.")) + { + if (xAbsent.Value == "disallow") + { + element.Add(new XAttribute("AllowAbsent", "no")); + } + xAbsent.Remove(); + } + + var xAllowAdvertise = element.Attribute("AllowAdvertise"); + if (xAllowAdvertise != null) + { + if ((xAllowAdvertise.Value == "system" || xAllowAdvertise.Value == "allow") && + this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value is deprecated. Set the value to 'yes' instead.", xAllowAdvertise.Value)) + { + xAllowAdvertise.Value = "yes"; + } + else if (xAllowAdvertise.Value == "disallow" && + this.OnError(ConverterTestType.FeatureAllowAdvertiseValueDeprecated, element, "The AllowAdvertise attribute's '{0}' value is deprecated. Remove the value instead.", xAllowAdvertise.Value)) + { + xAllowAdvertise.Remove(); + } + } + + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + var level = xCondition.Attribute("Level")?.Value; + if (!String.IsNullOrEmpty(level) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Level' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LevelElementName, + new XAttribute("Value", level), + new XAttribute("Condition", text) + )); + xCondition.Remove(); + } + } + } + + private void ConvertFileElement(XElement element) + { + if (this.SourceVersion < 4 && null == element.Attribute("Id")) + { + var attribute = element.Attribute("Name"); + + if (null == attribute) + { + attribute = element.Attribute("Source"); + } + + if (null != attribute) + { + var name = Path.GetFileName(attribute.Value); + + if (this.OnError(ConverterTestType.AssignAnonymousFileId, element, "The file id is being updated to '{0}' to ensure it remains the same as the v3 default", name)) + { + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + element.Add(new XAttribute("Id", GetIdentifierFromName(name))); + element.Add(attributes); + } + } + } + } + + private void ConvertFragmentElement(XElement element) + { + var remove = new List(); + + foreach (var xCondition in element.Elements(ConditionElementName)) + { + var message = xCondition.Attribute("Message")?.Value; + + if (!String.IsNullOrEmpty(message) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LaunchElementName, + new XAttribute("Condition", text), + new XAttribute("Message", message) + )); + remove.Add(xCondition); + } + } + + for (var i = remove.Count - 1; i >= 0; i--) + { + remove[i].Remove(); + } + } + + private void ConvertFirewallRemoteAddressElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertEmbeddedChainerElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertErrorElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + + private void ConvertExePackageElement(XElement element) + { + this.ConvertSuppressSignatureValidation(element); + + foreach (var attributeName in new[] { "InstallCommand", "RepairCommand", "UninstallCommand" }) + { + var newName = attributeName.Replace("Command", "Arguments"); + var attribute = element.Attribute(attributeName); + + if (attribute != null && + this.OnError(ConverterTestType.RenameExePackageCommandToArguments, element, "The {0} element {1} attribute has been renamed {2}.", element.Name.LocalName, attribute.Name.LocalName, newName)) + { + element.Add(new XAttribute(newName, attribute.Value)); + attribute.Remove(); + } + } + } + + private void ConvertPermissionExElement(XElement element) + { + var xCondition = element.Element(ConditionElementName); + if (xCondition != null) + { + if (TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Condition' attribute instead.", xCondition.Name.LocalName)) + { + element.Add(new XAttribute("Condition", text)); + xCondition.Remove(); + } + } + } + + private void ConvertProgressTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Message"); + + private void ConvertModuleElement(XElement element) + { + if (element.Attribute("Guid") == null // skip already-converted Module elements + && this.OnError(ConverterTestType.ModuleAndPackageRenamed, element, "The Module and Package elements have been renamed and reorganized for simplicity.")) + { + var xModule = element; + + var xSummaryInformation = xModule.Element(PackageElementName); + if (xSummaryInformation != null) + { + xSummaryInformation.Name = SummaryInformationElementName; + + var xInstallerVersion = xSummaryInformation.Attribute("InstallerVersion"); + if (this.SourceVersion < 4 && xInstallerVersion == null) + { + this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Module element."); + } + + RemoveAttribute(xSummaryInformation, "AdminImage"); + RemoveAttribute(xSummaryInformation, "Comments"); + MoveAttribute(xSummaryInformation, "Id", xModule, "Guid"); + MoveAttribute(xSummaryInformation, "InstallerVersion", xModule); + RemoveAttribute(xSummaryInformation, "Languages"); + RemoveAttribute(xSummaryInformation, "Platform"); + RemoveAttribute(xSummaryInformation, "Platforms"); + RemoveAttribute(xSummaryInformation, "ReadOnly"); + MoveAttribute(xSummaryInformation, "SummaryCodepage", xSummaryInformation, "Codepage", defaultValue: "1252"); + + if (!xSummaryInformation.HasAttributes) + { + xSummaryInformation.Remove(); + } + } + } + } + + private void ConvertProductElement(XElement element) + { + var id = element.Attribute("Id"); + if (id != null && id.Value == "*") + { + if (this.OnError(ConverterTestType.AutoGuidUnnecessary, element, "Using '*' for the Product Id attribute is unnecessary. Remove the attribute to remove the redundancy.")) + { + id.Remove(); + } + } + + var xConditions = element.Elements(ConditionElementName).ToList(); + foreach (var xCondition in xConditions) + { + var message = xCondition.Attribute("Message")?.Value; + + if (!String.IsNullOrEmpty(message) && + TryGetInnerText(xCondition, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the 'Launch' element instead.", xCondition.Name.LocalName)) + { + xCondition.AddAfterSelf(new XElement(LaunchElementName, + new XAttribute("Condition", text), + new XAttribute("Message", message) + )); + xCondition.Remove(); + } + } + + var xMediaTemplate = element.Element(MediaTemplateElementName); + if (xMediaTemplate?.HasAttributes == false + && this.OnError(ConverterTestType.DefaultMediaTemplate, element, "A MediaTemplate with no attributes set is now provided by default. Remove the element.")) + { + xMediaTemplate.Remove(); + } + + if (this.OnError(ConverterTestType.ProductAndPackageRenamed, element, "The Product and Package elements have been renamed and reorganized for simplicity.")) + { + var xPackage = element; + xPackage.Name = PackageElementName; + + var xSummaryInformation = xPackage.Element(PackageElementName); + if (xSummaryInformation != null) + { + xSummaryInformation.Name = SummaryInformationElementName; + + var xInstallerVersion = xSummaryInformation.Attribute("InstallerVersion"); + if (this.SourceVersion < 4 && xInstallerVersion == null) + { + this.OnError(ConverterTestType.InstallerVersionBehaviorChange, element, "Breaking change: The default value for Package/@InstallerVersion has been changed to '500' regardless of build platform. If you need a lower version, set it manually in the Package element."); + } + + if (xSummaryInformation.Attribute("Compressed") == null) + { + xPackage.SetAttributeValue("Compressed", "no"); + } + else + { + MoveAttribute(xSummaryInformation, "Compressed", xPackage, defaultValue: "yes"); + } + + RemoveAttribute(xSummaryInformation, "AdminImage"); + RemoveAttribute(xSummaryInformation, "Comments"); + RemoveAttribute(xSummaryInformation, "Id"); + MoveAttribute(xSummaryInformation, "InstallerVersion", xPackage, defaultValue: "500"); + MoveAttribute(xSummaryInformation, "InstallScope", xPackage, "Scope", defaultValue: "perMachine"); + RemoveAttribute(xSummaryInformation, "Languages"); + RemoveAttribute(xSummaryInformation, "Platform"); + RemoveAttribute(xSummaryInformation, "Platforms"); + RemoveAttribute(xSummaryInformation, "ReadOnly"); + MoveAttribute(xSummaryInformation, "ShortNames", xPackage); + MoveAttribute(xSummaryInformation, "SummaryCodepage", xSummaryInformation, "Codepage", defaultValue: "1252"); + MoveAttribute(xPackage, "Id", xPackage, "ProductCode"); + + var xInstallPrivileges = xSummaryInformation.Attribute("InstallPrivileges"); + switch (xInstallPrivileges?.Value) + { + case "limited": + xPackage.SetAttributeValue("Scope", "perUser"); + break; + case "elevated": + { + var xAllUsers = xPackage.Elements(PropertyElementName).SingleOrDefault(p => p.Attribute("Id")?.Value == "ALLUSERS"); + if (xAllUsers?.Attribute("Value")?.Value == "1") + { + xAllUsers?.Remove(); + } + } + break; + } + + xInstallPrivileges?.Remove(); + + if (!xSummaryInformation.HasAttributes) + { + xSummaryInformation.Remove(); + } + } + } + } + + private static void MoveAttribute(XElement xSource, string attributeName, XElement xDestination, string destinationAttributeName = null, string defaultValue = null) + { + var xAttribute = xSource.Attribute(attributeName); + if (xAttribute != null && (defaultValue == null || xAttribute.Value != defaultValue)) + { + xDestination.SetAttributeValue(destinationAttributeName ?? attributeName, xAttribute.Value); + } + + xAttribute?.Remove(); + } + + private static void RemoveAttribute(XElement xSummaryInformation, string attributeName) + { + var xAttribute = xSummaryInformation.Attribute(attributeName); + xAttribute?.Remove(); + } + + private void ConvertPropertyRefElement(XElement element) + { + var newElementName = String.Empty; + + var id = element.Attribute("Id"); + switch (id?.Value) + { + case "WIX_SUITE_BACKOFFICE": + case "WIX_SUITE_BLADE": + case "WIX_SUITE_COMMUNICATIONS": + case "WIX_SUITE_COMPUTE_SERVER": + case "WIX_SUITE_DATACENTER": + case "WIX_SUITE_EMBEDDED_RESTRICTED": + case "WIX_SUITE_EMBEDDEDNT": + case "WIX_SUITE_ENTERPRISE": + case "WIX_SUITE_MEDIACENTER": + case "WIX_SUITE_PERSONAL": + case "WIX_SUITE_SECURITY_APPLIANCE": + case "WIX_SUITE_SERVERR2": + case "WIX_SUITE_SINGLEUSERTS": + case "WIX_SUITE_SMALLBUSINESS": + case "WIX_SUITE_SMALLBUSINESS_RESTRICTED": + case "WIX_SUITE_STARTER": + case "WIX_SUITE_STORAGE_SERVER": + case "WIX_SUITE_TABLETPC": + case "WIX_SUITE_TERMINAL": + case "WIX_SUITE_WH_SERVER": + newElementName = "QueryWindowsSuiteInfo"; + break; + case "WIX_DIR_ADMINTOOLS": + case "WIX_DIR_ALTSTARTUP": + case "WIX_DIR_CDBURN_AREA": + case "WIX_DIR_COMMON_ADMINTOOLS": + case "WIX_DIR_COMMON_ALTSTARTUP": + case "WIX_DIR_COMMON_DOCUMENTS": + case "WIX_DIR_COMMON_FAVORITES": + case "WIX_DIR_COMMON_MUSIC": + case "WIX_DIR_COMMON_PICTURES": + case "WIX_DIR_COMMON_VIDEO": + case "WIX_DIR_COOKIES": + case "WIX_DIR_DESKTOP": + case "WIX_DIR_HISTORY": + case "WIX_DIR_INTERNET_CACHE": + case "WIX_DIR_MYMUSIC": + case "WIX_DIR_MYPICTURES": + case "WIX_DIR_MYVIDEO": + case "WIX_DIR_NETHOOD": + case "WIX_DIR_PERSONAL": + case "WIX_DIR_PRINTHOOD": + case "WIX_DIR_PROFILE": + case "WIX_DIR_RECENT": + case "WIX_DIR_RESOURCES": + newElementName = "QueryWindowsDirectories"; + break; + case "WIX_DWM_COMPOSITION_ENABLED": + case "WIX_WDDM_DRIVER_PRESENT": + newElementName = "QueryWindowsDriverInfo"; + break; + case "WIX_ACCOUNT_LOCALSYSTEM": + case "WIX_ACCOUNT_LOCALSERVICE": + case "WIX_ACCOUNT_NETWORKSERVICE": + case "WIX_ACCOUNT_ADMINISTRATORS": + case "WIX_ACCOUNT_USERS": + case "WIX_ACCOUNT_GUESTS": + case "WIX_ACCOUNT_PERFLOGUSERS": + case "WIX_ACCOUNT_PERFLOGUSERS_NODOMAIN": + newElementName = "QueryWindowsWellKnownSIDs"; + break; + } + + if (!String.IsNullOrEmpty(newElementName) + && this.OnError(ConverterTestType.UtilReferencesReplaced, element, "Custom action and property reference {0} to WixUtilExtension have been replaced with strongly-typed elements.", id)) + { + element.AddAfterSelf(new XElement(WixUtilNamespace + newElementName)); + element.Remove(); + } + } + + private void ConvertCustomActionRefElement(XElement element) + { + var newElementName = String.Empty; + + var id = element.Attribute("Id"); + switch (id?.Value) + { + case "WixBroadcastSettingChange": + case "WixBroadcastEnvironmentChange": + case "WixCheckRebootRequired": + case "WixExitEarlyWithSuccess": + case "WixFailWhenDeferred": + case "WixWaitForEvent": + case "WixWaitForEventDeferred": + newElementName = id?.Value.Substring(3); // strip leading Wix + break; + } + + if (!String.IsNullOrEmpty(newElementName) + && this.OnError(ConverterTestType.UtilReferencesReplaced, element, "Custom action and property reference {0} to WixUtilExtension have been replaced with strongly-typed elements.", id)) + { + element.AddAfterSelf(new XElement(WixUtilNamespace + newElementName)); + element.Remove(); + } + } + + private void ConvertPublishElement(XElement element) + { + this.ConvertInnerTextToAttribute(element, "Condition"); + + var xCondition = element.Attribute("Condition"); + if (xCondition?.Value == "1" && + this.OnError(ConverterTestType.PublishConditionOneUnnecessary, element, "Adding Condition='1' on {0} elements is no longer necessary. Remove the Condition attribute.", xCondition.Name.LocalName)) + { + xCondition.Remove(); + } + } + + private void ConvertMultiStringValueElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertRegistryKeyElement(XElement element) + { + var xAction = element.Attribute("Action"); + + if (xAction != null + && this.OnError(ConverterTestType.RegistryKeyActionObsolete, element, "The RegistryKey element's Action attribute is obsolete. Action='create' will be converted to ForceCreateOnInstall='yes'. Action='createAndRemoveOnUninstall' will be converted to ForceCreateOnInstall='yes' and ForceDeleteOnUninstall='yes'.")) + { + switch (xAction?.Value) + { + case "create": + element.SetAttributeValue("ForceCreateOnInstall", "yes"); + break; + case "createAndRemoveOnUninstall": + element.SetAttributeValue("ForceCreateOnInstall", "yes"); + element.SetAttributeValue("ForceDeleteOnUninstall", "yes"); + break; + } + + xAction.Remove(); + } + } + + private void ConvertRemotePayloadElement(XElement element) + { + var xParent = element.Parent; + + if (xParent.Name == ExePackageElementName && + this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'ExePackagePayload' instead.")) + { + element.Name = ExePackagePayloadElementName; + } + else if (xParent.Name == MsuPackageElementName && + this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'MsuPackagePayload' instead.")) + { + element.Name = MsuPackagePayloadElementName; + } + + var xName = xParent.Attribute("Name"); + if (xName != null && + this.OnError(ConverterTestType.NameAttributeMovedToRemotePayload, xParent, "The Name attribute must be specified on the child XxxPackagePayload element when using a remote payload.")) + { + element.SetAttributeValue("Name", xName.Value); + xName.Remove(); + } + + var xDownloadUrl = xParent.Attribute("DownloadUrl"); + if (xDownloadUrl != null && + this.OnError(ConverterTestType.DownloadUrlAttributeMovedToRemotePayload, xParent, "The DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload.")) + { + element.SetAttributeValue("DownloadUrl", xDownloadUrl.Value); + xDownloadUrl.Remove(); + } + + var xCompressed = xParent.Attribute("Compressed"); + if (xCompressed != null && + this.OnError(ConverterTestType.CompressedAttributeUnnecessaryForRemotePayload, xParent, "The Compressed attribute should not be specified when using a remote payload.")) + { + xCompressed.Remove(); + } + + this.OnError(ConverterTestType.BurnHashAlgorithmChanged, element, "The hash algorithm for bundles changed from SHA1 to SHA512."); + + this.RemoveAttributeIfPresent(element, "CertificatePublicKey", ConverterTestType.BundleSignatureValidationObsolete, "The {0} element contains obsolete '{1}' attribute. Signature validation is no longer supported. The attribute will be removed."); + this.RemoveAttributeIfPresent(element, "CertificateThumbprint", ConverterTestType.BundleSignatureValidationObsolete, "The {0} element contains obsolete '{1}' attribute. Signature validation is no longer supported. The attribute will be removed."); + } + + private void ConvertRegistrySearchElement(XElement element) + { + this.RenameWin64ToBitness(element); + } + + private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name"); + + private void ConvertDataElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSequenceElement(XElement element) + { + foreach (var child in element.Elements()) + { + this.ConvertInnerTextToAttribute(child, "Condition"); + } + } + + private void ConvertServiceArgumentElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertSetDirectoryElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertSetPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertProvidesElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = ProvidesElementName; + } + + if (element.Parent.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Add the 'Check' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyCheckAttributeName, "yes")); + } + } + + private void ConvertRequiresElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = RequiresElementName; + } + + if (element.Parent.Name == ProvidesElementName && + element.Parent.Parent?.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); + } + } + + private void ConvertRequiresRefElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = RequiresRefElementName; + } + + if (element.Parent.Name == ProvidesElementName && + element.Parent.Parent?.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); + } + } + + private void ConvertSuppressSignatureValidation(XElement element) + { + var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); + + if (null != suppressSignatureValidation + && this.OnError(ConverterTestType.BundleSignatureValidationObsolete, element, "The chain package element contains obsolete '{0}' attribute. Signature validation is no longer supported. The attribute will be removed.", suppressSignatureValidation.Name)) + { + suppressSignatureValidation.Remove(); + } + } + + private void ConvertTagElement(XElement element) + { + if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the 'SoftwareTag' element instead.")) + { + element.Name = SoftwareTagElementName; + } + + this.RemoveAttributeIfPresent(element, "Licensed", ConverterTestType.SoftwareTagLicensedObsolete, "The {0} element contains obsolete '{1}' attribute. The attribute will be removed."); + this.RemoveAttributeIfPresent(element, "Type", ConverterTestType.SoftwareTagLicensedObsolete, "The {0} element contains obsolete '{1}' attribute. The attribute will be removed."); + this.RenameWin64ToBitness(element); + } + + private void ConvertTagRefElement(XElement element) + { + if (this.OnError(ConverterTestType.TagRefElementRenamed, element, "The TagRef element has been renamed. Use the 'SoftwareTagRef' element instead.")) + { + element.Name = SoftwareTagRefElementName; + } + } + + private void ConvertTextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertUITextElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + private void ConvertWindowsInstallerPackageElement(XElement element) + { + this.ConvertSuppressSignatureValidation(element); + + if (null != element.Attribute("DisplayInternalUI")) + { + this.OnError(ConverterTestType.DisplayInternalUiNotConvertable, element, "The DisplayInternalUI functionality has fundamentally changed and requires BootstrapperApplication support."); + } + } + + private void ConvertVerbElement(XElement element) + { + if (null != element.Attribute("Target")) + { + this.OnError(ConverterTestType.VerbTargetNotConvertable, element, "The Verb/@Target attribute has been replaced with typed @TargetFile and @TargetProperty attributes."); + } + } + + private void ConvertCustomActionElement(XElement xCustomAction) + { + var xBinaryKey = xCustomAction.Attribute("BinaryKey"); + if (xBinaryKey != null && this.OnError(ConverterTestType.CustomActionKeysAreNowRefs, xCustomAction, "The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef.")) + { + xCustomAction.SetAttributeValue("BinaryRef", xBinaryKey.Value); + xBinaryKey.Remove(); + xBinaryKey = xCustomAction.Attribute("BinaryRef"); + } + + var xFileKey = xCustomAction.Attribute("FileKey"); + if (xFileKey != null && this.OnError(ConverterTestType.CustomActionKeysAreNowRefs, xCustomAction, "The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef.")) + { + xCustomAction.SetAttributeValue("FileRef", xFileKey.Value); + xFileKey.Remove(); + } + + if (xBinaryKey?.Value == "WixCA" || xBinaryKey?.Value == "UtilCA") + { + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X86' instead.")) + { + xBinaryKey.Value = "Wix4UtilCA_X86"; + } + } + + if (xBinaryKey?.Value == "WixCA_x64" || xBinaryKey?.Value == "UtilCA_x64") + { + if (this.OnError(ConverterTestType.WixCABinaryIdRenamed, xCustomAction, "The WixCA_x64 custom action DLL Binary table id has been renamed. Use the id 'Wix4UtilCA_X64' instead.")) + { + xBinaryKey.Value = "Wix4UtilCA_X64"; + } + } + + var xDllEntry = xCustomAction.Attribute("DllEntry"); + + if (xDllEntry?.Value == "CAQuietExec" || xDllEntry?.Value == "CAQuietExec64") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The CAQuietExec and CAQuietExec64 custom action ids have been renamed. Use the ids 'WixQuietExec' and 'WixQuietExec64' instead.")) + { + xDllEntry.Value = xDllEntry.Value.Replace("CAQuietExec", "WixQuietExec"); + } + } + + var xProperty = xCustomAction.Attribute("Property"); + + if (xProperty?.Value == "QtExecCmdLine" || xProperty?.Value == "QtExec64CmdLine") + { + if (this.OnError(ConverterTestType.QuietExecCustomActionsRenamed, xCustomAction, "The QtExecCmdLine and QtExec64CmdLine property ids have been renamed. Use the ids 'WixQuietExecCmdLine' and 'WixQuietExec64CmdLine' instead.")) + { + xProperty.Value = xProperty.Value.Replace("QtExec", "WixQuietExec"); + } + } + + var xScript = xCustomAction.Attribute("Script"); + + if (xScript != null && TryGetInnerText(xCustomAction, out var scriptText)) + { + if (this.OnError(ConverterTestType.InnerTextDeprecated, xCustomAction, "Using {0} element text is deprecated. Extract the text to a file and use the 'ScriptSourceFile' attribute to reference it.", xCustomAction.Name.LocalName)) + { + var scriptFolder = Path.GetDirectoryName(this.SourceFile) ?? String.Empty; + var id = xCustomAction.Attribute("Id")?.Value ?? Guid.NewGuid().ToString("N"); + var ext = (xScript.Value == "jscript") ? ".js" : (xScript.Value == "vbscript") ? ".vbs" : ".txt"; + + var scriptFile = Path.Combine(scriptFolder, id + ext); + File.WriteAllText(scriptFile, scriptText); + + RemoveChildren(xCustomAction); + xCustomAction.Add(new XAttribute("ScriptSourceFile", scriptFile)); + } + } + } + + private void ConvertVariableElement(XElement xVariable) + { + var xType = xVariable.Attribute("Type"); + var xValue = xVariable.Attribute("Value"); + if (this.SourceVersion < 4) + { + if (xType == null) + { + if (WasImplicitlyStringTyped(xValue?.Value) && + this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) + { + xVariable.Add(new XAttribute("Type", "formatted")); + } + } + else if (xType.Value == "string" && + this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) + { + xType.Value = "formatted"; + } + } + } + + private void ConvertPropertyElement(XElement xProperty) + { + var xId = xProperty.Attribute("Id"); + + if (xId.Value == "QtExecCmdTimeout") + { + this.OnError(ConverterTestType.QtExecCmdTimeoutAmbiguous, xProperty, "QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout."); + } + + this.ConvertInnerTextToAttribute(xProperty, "Value"); + } + + private void ConvertUtilCloseApplicationElementName(XElement element) => this.ConvertInnerTextToAttribute(element, "Condition"); + + private void ConvertUtilPermissionExElement(XElement element) + { + if (this.SourceVersion < 4 && null == element.Attribute("Inheritable")) + { + var inheritable = element.Parent.Name == CreateFolderElementName; + if (!inheritable) + { + if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default.")) + { + element.Add(new XAttribute("Inheritable", "no")); + } + } + } + } + + private void ConvertUtilRegistrySearchElement(XElement element) + { + this.RenameWin64ToBitness(element); + + if (this.SourceVersion < 4) + { + var result = element.Attribute("Result")?.Value; + if (result == null || result == "value") + { + this.OnError(ConverterTestType.UtilRegistryValueSearchBehaviorChange, element, "Breaking change: util:RegistrySearch for a value no longer clears the variable when the key or value is missing."); + } + } + } + + private void ConvertUtilXmlConfigElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + + /// + /// Converts a Wix element. + /// + /// The Wix element to convert. + /// The converted element. + private void ConvertElementWithoutNamespace(XElement element) + { + if (this.OnError(ConverterTestType.XmlnsMissing, element, "The xmlns attribute is missing. It must be present with a value of '{0}'.", WixNamespace.NamespaceName)) + { + element.Name = WixNamespace.GetName(element.Name.LocalName); + + element.Add(new XAttribute("xmlns", WixNamespace.NamespaceName)); // set the default namespace. + + foreach (var elementWithoutNamespace in element.DescendantsAndSelf().Where(e => XNamespace.None == e.Name.Namespace)) + { + elementWithoutNamespace.Name = WixNamespace.GetName(elementWithoutNamespace.Name.LocalName); + } + } + } + + private void ConvertInnerTextToAttribute(XElement element, string attributeName) + { + if (TryGetInnerText(element, out var text) && + this.OnError(ConverterTestType.InnerTextDeprecated, element, "Using {0} element text is deprecated. Use the '{1}' attribute instead.", element.Name.LocalName, attributeName)) + { + element.Add(new XAttribute(attributeName, text)); + RemoveChildren(element); + } + } + + void RemoveAttributeIfPresent(XElement element, string attributeName, ConverterTestType type, string format) + { + var xAttribute = element.Attribute(attributeName); + if (null != xAttribute && this.OnError(type, element, format, element.Name.LocalName, xAttribute.Name)) + { + xAttribute.Remove(); + } + } + + private void RenameWin64ToBitness(XElement element) + { + var win64 = element.Attribute("Win64"); + if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The {0} element's Win64 attribute has been renamed. Use the Bitness attribute instead.", element.Name.LocalName)) + { + var value = this.UpdateWin64ValueToBitnessValue(win64); + element.Add(new XAttribute("Bitness", value)); + win64.Remove(); + } + } + + private string UpdateWin64ValueToBitnessValue(XAttribute xWin64Attribute) + { + var value = xWin64Attribute.Value ?? String.Empty; + switch (value) + { + case "yes": + return "always64"; + case "no": + return "always32"; + default: + this.OnError(ConverterTestType.Win64AttributeRenameCannotBeAutomatic, xWin64Attribute, "Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute.", value); + return value; + } + } + + private IEnumerable YieldConverterTypes(IEnumerable types) + { + if (null != types) + { + foreach (var type in types) + { + if (Enum.TryParse(type, true, out var itt)) + { + yield return itt; + } + else // not a known ConverterTestType + { + this.OnError(ConverterTestType.ConverterTestTypeUnknown, null, "Unknown error type: '{0}'.", type); + } + } + } + } + + private static void UpdateElementsWithDeprecatedNamespaces(IEnumerable elements, Dictionary deprecatedToUpdatedNamespaces) + { + foreach (var element in elements) + { + if (deprecatedToUpdatedNamespaces.TryGetValue(element.Name.Namespace, out var ns)) + { + element.Name = ns.GetName(element.Name.LocalName); + } + + // Remove all the attributes and add them back to with their namespace updated (as necessary). + IEnumerable attributes = element.Attributes().ToList(); + element.RemoveAttributes(); + + foreach (var attribute in attributes) + { + var convertedAttribute = attribute; + + if (attribute.IsNamespaceDeclaration) + { + if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Value, out ns)) + { + if (ns == XNamespace.None) + { + continue; + } + + convertedAttribute = ("xmlns" == attribute.Name.LocalName) ? new XAttribute(attribute.Name.LocalName, ns.NamespaceName) : new XAttribute(XNamespace.Xmlns + attribute.Name.LocalName, ns.NamespaceName); + } + } + else if (deprecatedToUpdatedNamespaces.TryGetValue(attribute.Name.Namespace, out ns)) + { + convertedAttribute = new XAttribute(ns.GetName(attribute.Name.LocalName), attribute.Value); + } + + element.Add(convertedAttribute); + } + } + } + + /// + /// Determine if the whitespace preceding a node is appropriate for its depth level. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level that should match this whitespace. + /// The whitespace to validate. + /// true if the whitespace is legal; false otherwise. + private static bool LeadingWhitespaceValid(int indentationAmount, int level, string whitespace) + { + // Strip off leading newlines; there can be an arbitrary number of these. + whitespace = whitespace.TrimStart(XDocumentNewLine); + + var indentation = new string(' ', level * indentationAmount); + + return whitespace == indentation; + } + + /// + /// Fix the whitespace in a whitespace node. + /// + /// Indentation value to use when validating leading whitespace. + /// The depth level of the desired whitespace. + /// The whitespace node to fix. + private static void FixupWhitespace(int indentationAmount, int level, XText whitespace) + { + var value = new StringBuilder(whitespace.Value.Length); + + // Keep any previous preceeding new lines. + var newlines = whitespace.Value.TakeWhile(c => c == XDocumentNewLine).Count(); + + // Ensure there is always at least one new line before the indentation. + value.Append(XDocumentNewLine, newlines == 0 ? 1 : newlines); + + whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); + } + + /// + /// Removes unused namespaces from the element and its children. + /// + /// Root element to start at. + private void RemoveUnusedNamespaces(XElement root) + { + var declarations = new List(); + var namespaces = new HashSet(); + + VisitElement(root, x => + { + if (x is XAttribute a && a.IsNamespaceDeclaration) + { + declarations.Add(a); + namespaces.Add(a.Value); + } + return true; + }); + + foreach (var ns in namespaces.ToList()) + { + VisitElement(root, x => + { + if ((x is XElement e && e.Name.Namespace == ns) || + (x is XAttribute a && !a.IsNamespaceDeclaration && a.Name.Namespace == ns)) + { + namespaces.Remove(ns); + return false; + } + + return true; + }); + } + + foreach (var declaration in declarations) + { + if (namespaces.Contains(declaration.Value) && + this.OnError(ConverterTestType.RemoveUnusedNamespaces, declaration, "The namespace '{0}' is not used. Remove unused namespaces.", declaration.Value)) + { + declaration.Remove(); + } + } + } + + /// + /// Output an error message to the console. + /// + /// The type of converter test. + /// The node that caused the error. + /// Detailed error message. + /// Additional formatted string arguments. + /// Returns true indicating that action should be taken on this error, and false if it should be ignored. + private bool OnError(ConverterTestType converterTestType, XObject node, string message, params object[] args) + { + // Ignore the error if explicitly ignored or outside the range of the current operation. + if (this.IgnoreErrors.Contains(converterTestType) || + (this.Operation == ConvertOperation.Convert && converterTestType < ConverterTestType.EndIgnoreInConvert) || + (this.Operation == ConvertOperation.Format && converterTestType > ConverterTestType.BeginIgnoreInFormat)) + { + return false; + } + + // Increase the error count. + this.Errors++; + + var sourceLine = (null == node) ? new SourceLineNumber(this.SourceFile ?? "wix.exe") : new SourceLineNumber(this.SourceFile, ((IXmlLineInfo)node).LineNumber); + var warning = this.ErrorsAsWarnings.Contains(converterTestType); + var display = String.Format(CultureInfo.CurrentCulture, message, args); + + var msg = new Message(sourceLine, warning ? MessageLevel.Warning : MessageLevel.Error, (int)converterTestType, "{0} ({1})", display, converterTestType.ToString()); + + this.Messaging.Write(msg); + + return true; + } + + /// + /// Return an identifier based on passed file/directory name + /// + /// File/directory name to generate identifer from + /// A version of the name that is a legal identifier. + /// This is duplicated from WiX's Common class. + private static string GetIdentifierFromName(string name) + { + var result = IllegalIdentifierCharacters.Replace(name, "_"); // replace illegal characters with "_". + + // MSI identifiers must begin with an alphabetic character or an + // underscore. Prefix all other values with an underscore. + if (AddPrefix.IsMatch(name)) + { + result = String.Concat("_", result); + } + + return result; + } + + private static string LowercaseFirstChar(string value) + { + if (!String.IsNullOrEmpty(value)) + { + var c = Char.ToLowerInvariant(value[0]); + if (c != value[0]) + { + var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; + return c + remainder; + } + } + + return value; + } + + private static string UppercaseFirstChar(string value) + { + if (!String.IsNullOrEmpty(value)) + { + var c = Char.ToUpperInvariant(value[0]); + if (c != value[0]) + { + var remainder = value.Length > 1 ? value.Substring(1) : String.Empty; + return c + remainder; + } + } + + return value; + } + + private static bool TryGetInnerText(XElement element, out string value) + { + value = null; + + var nodes = element.Nodes(); + + if (nodes.All(e => e.NodeType == XmlNodeType.Text || e.NodeType == XmlNodeType.CDATA)) + { + value = String.Join(String.Empty, nodes.Cast().Select(TrimTextValue)); + } + + return !String.IsNullOrEmpty(value); + } + + private static bool IsTextNode(XNode node, out XText text) + { + text = null; + + if (node.NodeType == XmlNodeType.Text || node.NodeType == XmlNodeType.CDATA) + { + text = (XText)node; + } + + return text != null; + } + + private static void TrimLeadingText(XDocument document) + { + while (IsTextNode(document.Nodes().FirstOrDefault(), out var text)) + { + text.Remove(); + } + } + + private static string TrimTextValue(XText text) + { + var value = text.Value; + + if (String.IsNullOrEmpty(value)) + { + return String.Empty; + } + else if (text.NodeType == XmlNodeType.CDATA && String.IsNullOrWhiteSpace(value)) + { + return " "; + } + + return value.Trim(); + } + + private static void RemoveChildren(XElement element) + { + var nodes = element.Nodes().ToList(); + foreach (var node in nodes) + { + node.Remove(); + } + } + + private static bool VisitElement(XElement element, Func visitor) + { + if (!visitor(element)) + { + return false; + } + + if (!element.Attributes().All(a => visitor(a))) + { + return false; + } + + return element.Elements().All(e => VisitElement(e, visitor)); + } + + private static bool WasImplicitlyStringTyped(string value) + { + if (value == null) + { + return false; + } + else if (value.StartsWith("v", StringComparison.OrdinalIgnoreCase)) + { + if (Int32.TryParse(value.Substring(1), NumberStyles.None, CultureInfo.InvariantCulture.NumberFormat, out var _)) + { + return false; + } + else if (Version.TryParse(value.Substring(1), out var _)) + { + return false; + } + } + else if (Int64.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture.NumberFormat, out var _)) + { + return false; + } + + return true; + } + + /// + /// Converter test types. These are used to condition error messages down to warnings. + /// + private enum ConverterTestType + { + /// + /// Internal-only: displayed when a string cannot be converted to an ConverterTestType. + /// + ConverterTestTypeUnknown, + + /// + /// Displayed when an XML loading exception has occurred. + /// + XmlException, + + /// + /// Displayed when the whitespace preceding a node is wrong. + /// + WhitespacePrecedingNodeWrong, + + /// + /// Displayed when the whitespace preceding an end element is wrong. + /// + WhitespacePrecedingEndElementWrong, + + /// Before this point, ignore errors on convert operation + EndIgnoreInConvert, + + /// + /// Displayed when the XML declaration is present in the source file. + /// + DeclarationPresent, + + /// + /// Displayed when a file cannot be accessed; typically when trying to save back a fixed file. + /// + UnauthorizedAccessException, + + /// After this point, ignore errors on format operation + BeginIgnoreInFormat, + + /// + /// Displayed when the xmlns attribute is missing from the document element. + /// + XmlnsMissing, + + /// + /// Displayed when the xmlns attribute on the document element is wrong. + /// + XmlnsValueWrong, + + /// + /// Displayed when inner text contains a deprecated $(loc.xxx) reference. + /// + DeprecatedLocalizationVariablePrefixInTextValue, + + /// + /// Displayed when an attribute value contains a deprecated $(loc.xxx) reference. + /// + DeprecatedLocalizationVariablePrefixInAttributeValue, + + /// + /// Assign an identifier to a File element when on Id attribute is specified. + /// + AssignAnonymousFileId, + + /// + /// SuppressSignatureValidation attribute is obsolete and corresponding functionality removed. + /// + BundleSignatureValidationObsolete, + + /// + /// WixCA Binary/@Id has been renamed to UtilCA. + /// + WixCABinaryIdRenamed, + + /// + /// QtExec custom actions have been renamed. + /// + QuietExecCustomActionsRenamed, + + /// + /// QtExecCmdTimeout was previously used for both CAQuietExec and CAQuietExec64. For WixQuietExec, use WixQuietExecCmdTimeout. For WixQuietExec64, use WixQuietExec64CmdTimeout. + /// + QtExecCmdTimeoutAmbiguous, + + /// + /// Directory/@ShortName may only be specified with Directory/@Name. + /// + AssignDirectoryNameFromShortName, + + /// + /// BootstrapperApplicationData attribute is deprecated and replaced with Unreal for MSI. Use BundleCustomData element for Bundles. + /// + BootstrapperApplicationDataDeprecated, + + /// + /// Inheritable is new and is now defaulted to 'yes' which is a change in behavior for all but children of CreateFolder. + /// + AssignPermissionExInheritable, + + /// + /// Column element's Category attribute is camel-case. + /// + ColumnCategoryCamelCase, + + /// + /// Column element's Modularize attribute is camel-case. + /// + ColumnModularizeCamelCase, + + /// + /// Inner text value should move to an attribute. + /// + InnerTextDeprecated, + + /// + /// Explicit auto-GUID unnecessary. + /// + AutoGuidUnnecessary, + + /// + /// The Feature Absent attribute renamed to AllowAbsent. + /// + FeatureAbsentAttributeReplaced, + + /// + /// The Feature AllowAdvertise attribute value deprecated. + /// + FeatureAllowAdvertiseValueDeprecated, + + /// + /// The Condition='1' attribute is unnecessary on Publish elements. + /// + PublishConditionOneUnnecessary, + + /// + /// DpiAwareness is new and is defaulted to 'perMonitorV2' which is a change in behavior. + /// + AssignBootstrapperApplicationDpiAwareness, + + /// + /// The string variable type was previously treated as formatted. + /// + AssignVariableTypeFormatted, + + /// + /// The CustomAction attributes have been renamed from BinaryKey and FileKey to BinaryRef and FileRef. + /// + CustomActionKeysAreNowRefs, + + /// + /// The Product and Package elements have been renamed and reorganized. + /// + ProductAndPackageRenamed, + + /// + /// The Module and Package elements have been renamed and reorganized. + /// + ModuleAndPackageRenamed, + + /// + /// A MediaTemplate with no attributes set is now provided by default. + /// + DefaultMediaTemplate, + + /// + /// util:RegistrySearch has breaking change when value is missing. + /// + UtilRegistryValueSearchBehaviorChange, + + /// + /// DisplayInternalUI can't be converted. + /// + DisplayInternalUiNotConvertable, + + /// + /// InstallerVersion has breaking change when missing. + /// + InstallerVersionBehaviorChange, + + /// + /// Verb/@Target can't be converted. + /// + VerbTargetNotConvertable, + + /// + /// The bootstrapper application dll is now specified in its own element. + /// + BootstrapperApplicationDll, + + /// + /// The new bootstrapper application dll element is required. + /// + BootstrapperApplicationDllRequired, + + /// + /// bal:UseUILanguages is deprecated, 'true' is now the standard behavior. + /// + BalUseUILanguagesDeprecated, + + /// + /// The custom elements for built-in BAs are now required. + /// + BalBootstrapperApplicationRefToElement, + + /// + /// The ExePackage elements "XxxCommand" attributes have been renamed to "XxxArguments". + /// + RenameExePackageCommandToArguments, + + /// + /// The Win64 attribute has been renamed. Use the Bitness attribute instead. + /// + Win64AttributeRenamed, + + /// + /// Breaking change: The Win64 attribute's value '{0}' cannot be converted automatically to the new Bitness attribute. + /// + Win64AttributeRenameCannotBeAutomatic, + + /// + /// The Tag element has been renamed. Use the element 'SoftwareTag' name. + /// + TagElementRenamed, + + /// + /// The Dependency namespace has been incorporated into WiX v4 namespace. + /// + IntegratedDependencyNamespace, + + /// + /// Remove unused namespaces. + /// + RemoveUnusedNamespaces, + + /// + /// The Remote element has been renamed. Use the "XxxPackagePayload" element instead. + /// + RemotePayloadRenamed, + + /// + /// The XxxPackage/@Name attribute must be specified on the child XxxPackagePayload element when using a remote payload. + /// + NameAttributeMovedToRemotePayload, + + /// + /// The XxxPackage/@Compressed attribute should not be specified when using a remote payload. + /// + CompressedAttributeUnnecessaryForRemotePayload, + + /// + /// The XxxPackage/@DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload. + /// + DownloadUrlAttributeMovedToRemotePayload, + + /// + /// The hash algorithm used for bundles changed from SHA1 to SHA512. + /// + BurnHashAlgorithmChanged, + + /// + /// CustomTable elements can't always be converted. + /// + CustomTableNotAlwaysConvertable, + + /// + /// CustomTable elements that don't contain the table definition are now CustomTableRef. + /// + CustomTableRef, + + /// + /// The RegistryKey element's Action attribute is obsolete. + /// + RegistryKeyActionObsolete, + + /// + /// The TagRef element has been renamed. Use the element 'SoftwareTagRef' name. + /// + TagRefElementRenamed, + + /// + /// The SoftwareTag element's Licensed attribute is obsolete. + /// + SoftwareTagLicensedObsolete, + + /// + /// The SoftwareTag element's Type attribute is obsolete. + /// + SoftwareTagTypeObsolete, + + /// + /// TARGETDIR directory should not longer be explicitly defined. + /// + TargetDirDeprecated, + + /// + /// Standard directories should no longer be defined using the Directory element. + /// + DefiningStandardDirectoryDeprecated, + + /// + /// Naked custom action and property references replaced with WixUtilExtension elements. + /// + UtilReferencesReplaced, + } + } +} diff --git a/src/wix/WixToolset.Converters/WixToolset.Converters.csproj b/src/wix/WixToolset.Converters/WixToolset.Converters.csproj new file mode 100644 index 00000000..7dddefa5 --- /dev/null +++ b/src/wix/WixToolset.Converters/WixToolset.Converters.csproj @@ -0,0 +1,24 @@ + + + + + + + netstandard2.0 + $(TargetFrameworks);net461;net472 + Converter + WiX Toolset Converters + embedded + true + true + + + + + + + + + + + diff --git a/src/wix/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs b/src/wix/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs new file mode 100644 index 00000000..084d3b92 --- /dev/null +++ b/src/wix/WixToolset.Converters/WixToolsetCoreServiceProviderExtensions.cs @@ -0,0 +1,25 @@ +// 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.Converters +{ + using WixToolset.Extensibility.Services; + + /// + /// Extension methods for adding Converters services. + /// + public static class WixToolsetCoreServiceProviderExtensions + { + /// + /// Adds Converters services. + /// + /// + /// + public static IWixToolsetCoreServiceProvider AddConverter(this IWixToolsetCoreServiceProvider coreProvider) + { + var extensionManager = coreProvider.GetService(); + extensionManager.Add(typeof(ConverterExtensionFactory).Assembly); + + return coreProvider; + } + } +} diff --git a/src/wix/appveyor.cmd b/src/wix/appveyor.cmd new file mode 100644 index 00000000..02db695b --- /dev/null +++ b/src/wix/appveyor.cmd @@ -0,0 +1,20 @@ +@setlocal +@pushd %~dp0 +@set _P=%~dp0build\Release\publish +@set _C=Release +@if /i "%1"=="debug" set _C=Debug + +:: Restore +msbuild -p:Configuration=%_C% -t:Restore || exit /b + +:: Build +msbuild -p:Configuration=%_C% || exit /b + +:: Test +dotnet test -c %_C% --no-build || exit /b + +:: Pack +msbuild -p:Configuration=%_C% -p:NoBuild=true -t:Pack || exit /b + +@popd +@endlocal diff --git a/src/wix/appveyor.yml b/src/wix/appveyor.yml new file mode 100644 index 00000000..364569cf --- /dev/null +++ b/src/wix/appveyor.yml @@ -0,0 +1,44 @@ +# 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. +# +# Do NOT modify this file. Update the canonical version in Home\repo-template\src\appveyor.yml +# then update all of the repos. + +branches: + only: + - master + - develop + +image: Visual Studio 2019 + +version: 0.0.0.{build} +configuration: Release + +environment: + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + DOTNET_CLI_TELEMETRY_OPTOUT: 1 + NUGET_XMLDOC_MODE: skip + +build_script: + - appveyor.cmd + +test: off + +pull_requests: + do_not_increment_build_number: true + +nuget: + disable_publish_on_pr: true + +skip_branch_with_pr: true +skip_tags: true + +artifacts: +- path: build\Release\**\*.nupkg + name: nuget +- path: build\Release\**\*.snupkg + name: snupkg + +notifications: +- provider: Slack + incoming_webhook: + secure: p5xuu+4x2JHfwGDMDe5KcG1k7gZxqYc4jWVwvyNZv5cvkubPD2waJs5yXMAXZNN7Z63/3PWHb7q4KoY/99AjauYa1nZ4c5qYqRPFRBKTHfA= diff --git a/src/wix/deps/wix.dll b/src/wix/deps/wix.dll new file mode 100644 index 00000000..64f70f75 Binary files /dev/null and b/src/wix/deps/wix.dll differ diff --git a/src/wix/nuget.config b/src/wix/nuget.config new file mode 100644 index 00000000..31435a21 --- /dev/null +++ b/src/wix/nuget.config @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/wix/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs b/src/wix/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs new file mode 100644 index 00000000..01213524 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters.Symbolizer/ConvertSymbolsFixture.cs @@ -0,0 +1,606 @@ +// 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 WixToolsetTest.Converters.Symbolizer +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Linq; + using WixBuildTools.TestSupport; + using Wix3 = Microsoft.Tools.WindowsInstallerXml; + using WixToolset.Converters.Symbolizer; + using WixToolset.Data; + using WixToolset.Data.WindowsInstaller; + using WixToolset.Data.Symbols; + using Xunit; + + public class ConvertSymbolsFixture + { + [Fact] + public void CanLoadWixoutAndConvertToIntermediate() + { + var rootFolder = TestData.Get(); + var dataFolder = TestData.Get(@"TestData\Integration"); + + using (var fs = new DisposableFileSystem()) + { + var intermediateFolder = fs.GetFolder(); + + var path = Path.Combine(dataFolder, "test.wixout"); + + var intermediate = ConvertSymbols.ConvertFile(path); + + Assert.NotNull(intermediate); + Assert.Single(intermediate.Sections); + Assert.Equal(String.Empty, intermediate.Id); + + // Save and load to guarantee round-tripping support. + // + var wixiplFile = Path.Combine(intermediateFolder, "test.wixipl"); + intermediate.Save(wixiplFile); + + intermediate = Intermediate.Load(wixiplFile); + + var output = Wix3.Output.Load(path, suppressVersionCheck: true, suppressSchema: true); + var wixMediaByDiskId = IndexWixMediaTableByDiskId(output); + + // Dump to text for easy diffing, with some massaging to keep v3 and v4 diffable. + // + var tables = output.Tables.Cast(); + var wix3Dump = tables + .SelectMany(table => table.Rows.Cast() + .SelectMany(row => RowToStrings(row, wixMediaByDiskId))) + .Where(s => !String.IsNullOrEmpty(s)) + .OrderBy(s => s) + .ToArray(); + + var symbols = intermediate.Sections.SelectMany(s => s.Symbols); + + var assemblySymbolsByFileId = symbols.OfType().ToDictionary(a => a.Id.Id); + + var wix4Dump = symbols + .SelectMany(symbol => SymbolToStrings(symbol, assemblySymbolsByFileId)) + .OrderBy(s => s) + .ToArray(); + +#if false + Assert.Equal(wix3Dump, wix4Dump); +#else // useful when you want to diff the outputs with another diff tool. + var wix3TextDump = String.Join(Environment.NewLine, wix3Dump); + var wix4TextDump = String.Join(Environment.NewLine, wix4Dump); + + var path3 = Path.Combine(Path.GetTempPath(), "~3.txt"); + var path4 = Path.Combine(Path.GetTempPath(), "~4.txt"); + + File.WriteAllText(path3, wix3TextDump); + File.WriteAllText(path4, wix4TextDump); + + Assert.Equal(wix3TextDump, wix4TextDump); +#endif + } + } + + private static Dictionary IndexWixMediaTableByDiskId(Wix3.Output output) + { + var wixMediaByDiskId = new Dictionary(); + var wixMediaTable = output.Tables["WixMedia"]; + + if (wixMediaTable != null) + { + foreach (Wix3.WixMediaRow row in wixMediaTable.Rows) + { + wixMediaByDiskId.Add((int)row[0], row); + } + } + + return wixMediaByDiskId; + } + + private static IEnumerable RowToStrings(Wix3.Row row, Dictionary wixMediaByDiskId) + { + string fields = null; + + // Massage output to match WiX v3 rows and v4 symbols. + // + switch (row.Table.Name) + { + case "Directory": + var dirs = SplitDefaultDir((string)row[2]); + fields = String.Join(",", row[0], row[1], dirs[0], dirs[1], dirs[2], dirs[3]); + break; + case "File": + { + var fieldValues = row.Fields.Take(7).Select(SafeConvertField).ToArray(); + if (fieldValues[3] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[3] = "0"; + } + fields = String.Join(",", fieldValues); + break; + } + case "Media": + var compression = wixMediaByDiskId.TryGetValue((int)row[0], out var wixMedia) ? (CompressionLevel?)Enum.Parse(typeof(CompressionLevel), SafeConvertField(wixMedia.Fields[1]), true) : null; + + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + fields = String.Join(",", fields, (int?)compression, SafeConvertField(wixMedia?.Fields[2])); + break; + case "RegLocator": + var type = (int)row[4]; + fields = String.Join(",", row[0], row[1], row[2], row[3], type & 0xF, (type & 0x10) == 0x10); + break; + case "RemoveFile": + var attributes = (int)row[4]; + var onInstall = (attributes & 1) == 1 ? (bool?)true : null; + var onUninstall = (attributes & 2) == 2 ? (bool?)true : null; + fields = String.Join(",", row.Fields.Take(4).Select(SafeConvertField)); + fields = String.Join(",", fields, onInstall, onUninstall); + break; + case "Shortcut": + var split = ((string)row[2]).Split('|'); + var afterName = String.Join(",", row.Fields.Skip(3).Select(SafeConvertField)); + fields = String.Join(",", row[0], row[1], split.Length > 1 ? split[1] : split[0], split.Length > 1 ? split[0] : String.Empty, afterName); + break; + case "WixAction": + var table = (int)SequenceStringToSequenceTable(row[0]); + fields = String.Join(",", table, row[1], row[2], row[3], row[4], row[5], row[6]); + break; + case "WixFile": + { + var fieldValues = row.Fields.Select(SafeConvertField).ToArray(); + if (fieldValues[8] == null) + { + // "Somebody" sometimes writes out a null field even when the column definition says + // it's non-nullable. Not naming names or anything. (SWID tags.) + fieldValues[8] = "0"; + } + if (fieldValues[10] == null) + { + // WixFile rows that come from merge modules will not have the attributes column set + // so initilaize with 0. + fieldValues[10] = "0"; + } + fields = String.Join(",", fieldValues); + break; + } + case "WixMedia": + break; + default: + fields = String.Join(",", row.Fields.Select(SafeConvertField)); + break; + } + + if (fields != null) + { + yield return $"{row.Table.Name}:{fields}"; + } + } + + private static IEnumerable SymbolToStrings(IntermediateSymbol symbol, Dictionary assemblySymbolsByFileId) + { + var name = symbol.Definition.Type == SymbolDefinitionType.SummaryInformation ? "_SummaryInformation" : symbol.Definition.Name; + var id = symbol.Id?.Id ?? String.Empty; + + string fields; + switch (symbol.Definition.Name) + { + // Massage output to match WiX v3 rows and v4 symbols. + // + case "Component": + { + var componentSymbol = (ComponentSymbol)symbol; + var attributes = ComponentLocation.Either == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesOptional : 0; + attributes |= ComponentLocation.SourceOnly == componentSymbol.Location ? WindowsInstallerConstants.MsidbComponentAttributesSourceOnly : 0; + attributes |= ComponentKeyPathType.Registry == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath : 0; + attributes |= ComponentKeyPathType.OdbcDataSource == componentSymbol.KeyPathType ? WindowsInstallerConstants.MsidbComponentAttributesODBCDataSource : 0; + attributes |= componentSymbol.DisableRegistryReflection ? WindowsInstallerConstants.MsidbComponentAttributesDisableRegistryReflection : 0; + attributes |= componentSymbol.NeverOverwrite ? WindowsInstallerConstants.MsidbComponentAttributesNeverOverwrite : 0; + attributes |= componentSymbol.Permanent ? WindowsInstallerConstants.MsidbComponentAttributesPermanent : 0; + attributes |= componentSymbol.SharedDllRefCount ? WindowsInstallerConstants.MsidbComponentAttributesSharedDllRefCount : 0; + attributes |= componentSymbol.Shared ? WindowsInstallerConstants.MsidbComponentAttributesShared : 0; + attributes |= componentSymbol.Transitive ? WindowsInstallerConstants.MsidbComponentAttributesTransitive : 0; + attributes |= componentSymbol.UninstallWhenSuperseded ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + attributes |= componentSymbol.Win64 ? WindowsInstallerConstants.MsidbComponentAttributes64bit : 0; + + fields = String.Join(",", + componentSymbol.ComponentId, + componentSymbol.DirectoryRef, + attributes.ToString(), + componentSymbol.Condition, + componentSymbol.KeyPath + ); + break; + } + case "CustomAction": + { + var customActionSymbol = (CustomActionSymbol)symbol; + var type = customActionSymbol.Win64 ? WindowsInstallerConstants.MsidbCustomActionType64BitScript : 0; + type |= customActionSymbol.TSAware ? WindowsInstallerConstants.MsidbCustomActionTypeTSAware : 0; + type |= customActionSymbol.Impersonate ? 0 : WindowsInstallerConstants.MsidbCustomActionTypeNoImpersonate; + type |= customActionSymbol.IgnoreResult ? WindowsInstallerConstants.MsidbCustomActionTypeContinue : 0; + type |= customActionSymbol.Hidden ? WindowsInstallerConstants.MsidbCustomActionTypeHideTarget : 0; + type |= customActionSymbol.Async ? WindowsInstallerConstants.MsidbCustomActionTypeAsync : 0; + type |= CustomActionExecutionType.FirstSequence == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeFirstSequence : 0; + type |= CustomActionExecutionType.OncePerProcess == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeOncePerProcess : 0; + type |= CustomActionExecutionType.ClientRepeat == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeClientRepeat : 0; + type |= CustomActionExecutionType.Deferred == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript : 0; + type |= CustomActionExecutionType.Rollback == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeRollback : 0; + type |= CustomActionExecutionType.Commit == customActionSymbol.ExecutionType ? WindowsInstallerConstants.MsidbCustomActionTypeInScript | WindowsInstallerConstants.MsidbCustomActionTypeCommit : 0; + type |= CustomActionSourceType.File == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeSourceFile : 0; + type |= CustomActionSourceType.Directory == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeDirectory : 0; + type |= CustomActionSourceType.Property == customActionSymbol.SourceType ? WindowsInstallerConstants.MsidbCustomActionTypeProperty : 0; + type |= CustomActionTargetType.Dll == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeDll : 0; + type |= CustomActionTargetType.Exe == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeExe : 0; + type |= CustomActionTargetType.TextData == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeTextData : 0; + type |= CustomActionTargetType.JScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeJScript : 0; + type |= CustomActionTargetType.VBScript == customActionSymbol.TargetType ? WindowsInstallerConstants.MsidbCustomActionTypeVBScript : 0; + + fields = String.Join(",", + type.ToString(), + customActionSymbol.Source, + customActionSymbol.Target, + customActionSymbol.PatchUninstall ? WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall.ToString() : null + ); + break; + } + case "Directory": + { + var directorySymbol = (DirectorySymbol)symbol; + + if (!String.IsNullOrEmpty(directorySymbol.ComponentGuidGenerationSeed)) + { + yield return $"WixDirectory:{directorySymbol.Id.Id},{directorySymbol.ComponentGuidGenerationSeed}"; + } + + fields = String.Join(",", directorySymbol.ParentDirectoryRef, directorySymbol.Name, directorySymbol.ShortName, directorySymbol.SourceName, directorySymbol.SourceShortName); + break; + } + case "Feature": + { + var featureSymbol = (FeatureSymbol)symbol; + var attributes = featureSymbol.DisallowAbsent ? WindowsInstallerConstants.MsidbFeatureAttributesUIDisallowAbsent : 0; + attributes |= featureSymbol.DisallowAdvertise ? WindowsInstallerConstants.MsidbFeatureAttributesDisallowAdvertise : 0; + attributes |= FeatureInstallDefault.FollowParent == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFollowParent : 0; + attributes |= FeatureInstallDefault.Source == featureSymbol.InstallDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorSource : 0; + attributes |= FeatureTypicalDefault.Advertise == featureSymbol.TypicalDefault ? WindowsInstallerConstants.MsidbFeatureAttributesFavorAdvertise : 0; + + fields = String.Join(",", + featureSymbol.ParentFeatureRef, + featureSymbol.Title, + featureSymbol.Description, + featureSymbol.Display.ToString(), + featureSymbol.Level.ToString(), + featureSymbol.DirectoryRef, + attributes.ToString()); + break; + } + case "File": + { + var fileSymbol = (FileSymbol)symbol; + + if (fileSymbol.BindPath != null) + { + yield return $"BindImage:{fileSymbol.Id.Id},{fileSymbol.BindPath}"; + } + + if (fileSymbol.FontTitle != null) + { + yield return $"Font:{fileSymbol.Id.Id},{fileSymbol.FontTitle}"; + } + + if (fileSymbol.SelfRegCost.HasValue) + { + yield return $"SelfReg:{fileSymbol.Id.Id},{fileSymbol.SelfRegCost}"; + } + + int? assemblyAttributes = null; + if (assemblySymbolsByFileId.TryGetValue(fileSymbol.Id.Id, out var assemblySymbol)) + { + if (assemblySymbol.Type == AssemblyType.DotNetAssembly) + { + assemblyAttributes = 0; + } + else if (assemblySymbol.Type == AssemblyType.Win32Assembly) + { + assemblyAttributes = 1; + } + } + + yield return "WixFile:" + String.Join(",", + fileSymbol.Id.Id, + assemblyAttributes, + assemblySymbol?.ManifestFileRef, + assemblySymbol?.ApplicationFileRef, + fileSymbol.DirectoryRef, + fileSymbol.DiskId, + fileSymbol.Source.Path, + null, // assembly processor arch + fileSymbol.PatchGroup, + 0, + (int)fileSymbol.PatchAttributes, + fileSymbol.RetainLengths, + fileSymbol.IgnoreOffsets, + fileSymbol.IgnoreLengths, + fileSymbol.RetainOffsets + ); + + var fileAttributes = 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.ReadOnly) != 0 ? WindowsInstallerConstants.MsidbFileAttributesReadOnly : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Hidden) != 0 ? WindowsInstallerConstants.MsidbFileAttributesHidden : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.System) != 0 ? WindowsInstallerConstants.MsidbFileAttributesSystem : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Vital) != 0 ? WindowsInstallerConstants.MsidbFileAttributesVital : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Checksum) != 0 ? WindowsInstallerConstants.MsidbFileAttributesChecksum : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Compressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesCompressed : 0; + fileAttributes |= (fileSymbol.Attributes & FileSymbolAttributes.Uncompressed) != 0 ? WindowsInstallerConstants.MsidbFileAttributesNoncompressed : 0; + + fields = String.Join(",", + fileSymbol.ComponentRef, + fileSymbol.Name, + fileSymbol.FileSize.ToString(), + fileSymbol.Version, + fileSymbol.Language, + fileAttributes); + break; + } + + case "Media": + fields = String.Join(",", symbol.Fields.Skip(1).Select(SafeConvertField)); + break; + + case "Assembly": + { + var assemblySymbol = (AssemblySymbol)symbol; + + id = null; + name = "MsiAssembly"; + fields = String.Join(",", assemblySymbol.ComponentRef, assemblySymbol.FeatureRef, assemblySymbol.ManifestFileRef, assemblySymbol.ApplicationFileRef, assemblySymbol.Type == AssemblyType.Win32Assembly ? 1 : 0); + break; + } + case "RegLocator": + { + var locatorSymbol = (RegLocatorSymbol)symbol; + + fields = String.Join(",", (int)locatorSymbol.Root, locatorSymbol.Key, locatorSymbol.Name, (int)locatorSymbol.Type, locatorSymbol.Win64); + break; + } + case "Registry": + { + var registrySymbol = (RegistrySymbol)symbol; + var value = registrySymbol.Value; + + switch (registrySymbol.ValueType) + { + case RegistryValueType.Binary: + value = String.Concat("#x", value); + break; + case RegistryValueType.Expandable: + value = String.Concat("#%", value); + break; + case RegistryValueType.Integer: + value = String.Concat("#", value); + break; + case RegistryValueType.MultiString: + switch (registrySymbol.ValueAction) + { + case RegistryValueActionType.Append: + value = String.Concat("[~]", value); + break; + case RegistryValueActionType.Prepend: + value = String.Concat(value, "[~]"); + break; + case RegistryValueActionType.Write: + default: + if (null != value && -1 == value.IndexOf("[~]", StringComparison.Ordinal)) + { + value = String.Concat("[~]", value, "[~]"); + } + break; + } + break; + case RegistryValueType.String: + // escape the leading '#' character for string registry keys + if (null != value && value.StartsWith("#", StringComparison.Ordinal)) + { + value = String.Concat("#", value); + } + break; + } + + fields = String.Join(",", + ((int)registrySymbol.Root).ToString(), + registrySymbol.Key, + registrySymbol.Name, + value, + registrySymbol.ComponentRef + ); + break; + } + + case "RemoveRegistry": + { + var removeRegistrySymbol = (RemoveRegistrySymbol)symbol; + fields = String.Join(",", + ((int)removeRegistrySymbol.Root).ToString(), + removeRegistrySymbol.Key, + removeRegistrySymbol.Name, + removeRegistrySymbol.ComponentRef + ); + break; + } + + case "ServiceControl": + { + var serviceControlSymbol = (ServiceControlSymbol)symbol; + + var events = serviceControlSymbol.InstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventDelete : 0; + events |= serviceControlSymbol.UninstallRemove ? WindowsInstallerConstants.MsidbServiceControlEventUninstallDelete : 0; + events |= serviceControlSymbol.InstallStart ? WindowsInstallerConstants.MsidbServiceControlEventStart : 0; + events |= serviceControlSymbol.UninstallStart ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStart : 0; + events |= serviceControlSymbol.InstallStop ? WindowsInstallerConstants.MsidbServiceControlEventStop : 0; + events |= serviceControlSymbol.UninstallStop ? WindowsInstallerConstants.MsidbServiceControlEventUninstallStop : 0; + + fields = String.Join(",", + serviceControlSymbol.Name, + events.ToString(), + serviceControlSymbol.Arguments, + serviceControlSymbol.Wait == true ? "1" : "0", + serviceControlSymbol.ComponentRef + ); + break; + } + + case "ServiceInstall": + { + var serviceInstallSymbol = (ServiceInstallSymbol)symbol; + + var errorControl = (int)serviceInstallSymbol.ErrorControl; + errorControl |= serviceInstallSymbol.Vital ? WindowsInstallerConstants.MsidbServiceInstallErrorControlVital : 0; + + var serviceType = (int)serviceInstallSymbol.ServiceType; + serviceType |= serviceInstallSymbol.Interactive ? WindowsInstallerConstants.MsidbServiceInstallInteractive : 0; + + fields = String.Join(",", + serviceInstallSymbol.Name, + serviceInstallSymbol.DisplayName, + serviceType.ToString(), + ((int)serviceInstallSymbol.StartType).ToString(), + errorControl.ToString(), + serviceInstallSymbol.LoadOrderGroup, + serviceInstallSymbol.Dependencies, + serviceInstallSymbol.StartName, + serviceInstallSymbol.Password, + serviceInstallSymbol.Arguments, + serviceInstallSymbol.ComponentRef, + serviceInstallSymbol.Description + ); + break; + } + + case "Upgrade": + { + var upgradeSymbol = (UpgradeSymbol)symbol; + + var attributes = upgradeSymbol.MigrateFeatures ? WindowsInstallerConstants.MsidbUpgradeAttributesMigrateFeatures : 0; + attributes |= upgradeSymbol.OnlyDetect ? WindowsInstallerConstants.MsidbUpgradeAttributesOnlyDetect : 0; + attributes |= upgradeSymbol.IgnoreRemoveFailures ? WindowsInstallerConstants.MsidbUpgradeAttributesIgnoreRemoveFailure : 0; + attributes |= upgradeSymbol.VersionMinInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMinInclusive : 0; + attributes |= upgradeSymbol.VersionMaxInclusive ? WindowsInstallerConstants.MsidbUpgradeAttributesVersionMaxInclusive : 0; + attributes |= upgradeSymbol.ExcludeLanguages ? WindowsInstallerConstants.MsidbUpgradeAttributesLanguagesExclusive : 0; + + fields = String.Join(",", + upgradeSymbol.VersionMin, + upgradeSymbol.VersionMax, + upgradeSymbol.Language, + attributes.ToString(), + upgradeSymbol.Remove, + upgradeSymbol.ActionProperty + ); + break; + } + + case "WixAction": + { + var wixActionSymbol = (WixActionSymbol)symbol; + var data = wixActionSymbol.Fields[(int)WixActionSymbolFields.SequenceTable].AsObject(); + var sequenceTableAsInt = data is string ? (int)SequenceStringToSequenceTable(data) : (int)wixActionSymbol.SequenceTable; + + fields = String.Join(",", + sequenceTableAsInt, + wixActionSymbol.Action, + wixActionSymbol.Condition, + wixActionSymbol.Sequence?.ToString() ?? String.Empty, + wixActionSymbol.Before, + wixActionSymbol.After, + wixActionSymbol.Overridable == true ? "1" : "0" + ); + break; + } + + case "WixComplexReference": + { + var wixComplexReferenceSymbol = (WixComplexReferenceSymbol)symbol; + fields = String.Join(",", + wixComplexReferenceSymbol.Parent, + (int)wixComplexReferenceSymbol.ParentType, + wixComplexReferenceSymbol.ParentLanguage, + wixComplexReferenceSymbol.Child, + (int)wixComplexReferenceSymbol.ChildType, + wixComplexReferenceSymbol.IsPrimary ? "1" : "0" + ); + break; + } + + case "WixProperty": + { + var wixPropertySymbol = (WixPropertySymbol)symbol; + var attributes = wixPropertySymbol.Admin ? 0x1 : 0; + attributes |= wixPropertySymbol.Hidden ? 0x2 : 0; + attributes |= wixPropertySymbol.Secure ? 0x4 : 0; + + fields = String.Join(",", + wixPropertySymbol.PropertyRef, + attributes.ToString() + ); + break; + } + + default: + fields = String.Join(",", symbol.Fields.Select(SafeConvertField)); + break; + } + + fields = String.IsNullOrEmpty(id) ? fields : String.IsNullOrEmpty(fields) ? id : $"{id},{fields}"; + yield return $"{name}:{fields}"; + } + + private static SequenceTable SequenceStringToSequenceTable(object sequenceString) + { + switch (sequenceString) + { + case "AdminExecuteSequence": + return SequenceTable.AdminExecuteSequence; + case "AdminUISequence": + return SequenceTable.AdminUISequence; + case "AdvtExecuteSequence": + return SequenceTable.AdvertiseExecuteSequence; + case "InstallExecuteSequence": + return SequenceTable.InstallExecuteSequence; + case "InstallUISequence": + return SequenceTable.InstallUISequence; + default: + throw new ArgumentException($"Unknown sequence: {sequenceString}"); + } + } + + private static string SafeConvertField(Wix3.Field field) + { + return field?.Data?.ToString(); + } + + private static string SafeConvertField(IntermediateField field) + { + var data = field.AsObject(); + if (data is IntermediateFieldPathValue path) + { + return path.Path; + } + + return data?.ToString(); + } + + private static string[] SplitDefaultDir(string defaultDir) + { + var split1 = defaultDir.Split(':'); + var targetSplit = split1.Length > 1 ? split1[1].Split('|') : split1[0].Split('|'); + var sourceSplit = split1.Length > 1 ? split1[0].Split('|') : new[] { String.Empty }; + return new[] + { + targetSplit.Length > 1 ? targetSplit[1] : targetSplit[0], + targetSplit.Length > 1 ? targetSplit[0] : String.Empty, + sourceSplit.Length > 1 ? sourceSplit[1] : sourceSplit[0], + sourceSplit.Length > 1 ? sourceSplit[0] : String.Empty + }; + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout b/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout new file mode 100644 index 00000000..da64b8af Binary files /dev/null and b/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixout differ diff --git a/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj b/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj new file mode 100644 index 00000000..d7c4e625 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wixproj @@ -0,0 +1,47 @@ + + + + Debug + x86 + 3.10 + d59f1c1e-9238-49fa-bfa2-ec1d9c2dda1d + 2.0 + SymbolizerWixout + Package + + + bin\$(Configuration)\ + obj\$(Configuration)\ + Debug + + + bin\$(Configuration)\ + obj\$(Configuration)\ + + + + + + + $(WixExtDir)\WixUtilExtension.dll + WixUtilExtension + + + $(WixExtDir)\WixNetFxExtension.dll + WixNetFxExtension + + + + + + + + + \ No newline at end of file diff --git a/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs b/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs new file mode 100644 index 00000000..46d4fb43 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters.Symbolizer/TestData/Integration/test.wxs @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj b/src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj new file mode 100644 index 00000000..995d9297 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.csproj @@ -0,0 +1,33 @@ + + + + + + + net461 + false + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject b/src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject new file mode 100644 index 00000000..18ab4f79 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters.Symbolizer/WixToolsetTest.Converters.Symbolizer.v3.ncrunchproject @@ -0,0 +1,9 @@ + + + + + WixToolsetTest.Converters.Symbolizer.ConvertSymbolsFixture.CanLoadWixoutAndConvertToIntermediate + + + + \ No newline at end of file diff --git a/src/wix/test/WixToolsetTest.Converters/BaseConverterFixture.cs b/src/wix/test/WixToolsetTest.Converters/BaseConverterFixture.cs new file mode 100644 index 00000000..2421d73b --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/BaseConverterFixture.cs @@ -0,0 +1,33 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Text; + using System.Xml; + using System.Xml.Linq; + using Xunit; + + public abstract class BaseConverterFixture + { + protected static string UnformattedDocumentString(XDocument document, bool omitXmlDeclaration = true) + { + var sb = new StringBuilder(); + + using (var writer = new StringWriter(sb)) + using (var xml = XmlWriter.Create(writer, new XmlWriterSettings { OmitXmlDeclaration = omitXmlDeclaration })) + { + document.Save(xml); + } + + return sb.ToString().TrimStart(); + } + + protected static string[] UnformattedDocumentLines(XDocument document, bool omitXmlDeclaration = true) + { + var unformatted = UnformattedDocumentString(document, omitXmlDeclaration); + return unformatted.Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/BitnessFixture.cs b/src/wix/test/WixToolsetTest.Converters/BitnessFixture.cs new file mode 100644 index 00000000..e45a9388 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/BitnessFixture.cs @@ -0,0 +1,187 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class BitnessFixture : BaseConverterFixture + { + [Fact] + public void FixComponentBitness() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(10, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixRegistrySearchBitness() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixUtilRegistrySearchBitness() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixApprovedExeBitness() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/wix/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs new file mode 100644 index 00000000..158ab3be --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -0,0 +1,418 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class BootstrapperApplicationFixture : BaseConverterFixture + { + [Fact] + public void CantCreateBootstrapperApplicationDllFromV3PayloadGroupRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(2, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertDotNetCoreBootstrapperApplicationRefWithExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertDotNetCoreBootstrapperApplicationRefWithoutExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertFrameworkBootstrapperApplicationRefWithExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertFrameworkBootstrapperApplicationRefWithoutExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertStandardBootstrapperApplicationRefWithExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void ConvertStandardBootstrapperApplicationRefWithoutExistingElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CreateBootstrapperApplicationDllFromV3() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CreateBootstrapperApplicationDllFromV3Payload() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void DoesntSetDpiUnawareFromV4() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(0, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void KeepsDpiAwarenessFromV4() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + "", + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void RemovesBalUseUILanguages() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/ConditionFixture.cs b/src/wix/test/WixToolsetTest.Converters/ConditionFixture.cs new file mode 100644 index 00000000..d3f65aeb --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/ConditionFixture.cs @@ -0,0 +1,297 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ConditionFixture : BaseConverterFixture + { + [Fact] + public void FixControlCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " x=y", + " a<>b", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPublishCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " 1<2", + " 1", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixComponentCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " 1<2", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixFeatureCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " PROP = 1", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixLaunchCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " 1<2", + " ", + " ", + " 1=2", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixLaunchConditionInProduct() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " 1<2", + " ", + " ", + " 1=2", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPermissionExCondition() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " 1<2", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/wix/test/WixToolsetTest.Converters/ConverterFixture.cs new file mode 100644 index 00000000..13df9da7 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -0,0 +1,449 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ConverterFixture : BaseConverterFixture + { + private static readonly XNamespace Wix4Namespace = "http://wixtoolset.org/schemas/v4/wxs"; + + [Fact] + public void EnsuresNoDeclaration() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void EnsuresDeclarationWhenIgnored() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, ignoreErrors: new[] { "DeclarationPresent" } ); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document, omitXmlDeclaration: false); + + Assert.Equal(0, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertMainNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + //Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertNamedMainNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); + } + + [Fact] + public void CanConvertNonWixDefaultNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(3, errors); + Assert.Equal(Wix4Namespace, document.Root.GetNamespaceOfPrefix("w")); + Assert.Equal("http://wixtoolset.org/schemas/v4/wxs/util", document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanRemoveUnusedNamespaces() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(4, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanConvertMissingWixNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanConvertMissingIncludeNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); + } + + [Fact] + public void CanConvertAnonymousFile() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(3, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertShortNameDirectoryWithoutName() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertCatalogElement() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertSuppressSignatureValidationNo() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertSuppressSignatureValidationYes() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CantConvertVerbTarget() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertDeprecatedPrefix() + { + var parse = String.Join(Environment.NewLine, + "", + "", + "", + "", + "", + "", + "", + "", + ""); + + var expected = String.Join(Environment.NewLine, + "", + "", + "", + "", + "", + "", + "", + "", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(3, errors); + Assert.Equal(expected, actual); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs b/src/wix/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs new file mode 100644 index 00000000..a39f6243 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/ConverterIntegrationFixture.cs @@ -0,0 +1,195 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolset.Core; + using WixToolset.Core.TestPackage; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ConverterIntegrationFixture + { + [Fact] + public void CanConvertPermissionExFile() + { + const string beforeFileName = "v3.wxs"; + const string afterFileName = "v4_expected.wxs"; + var folder = TestData.Get(@"TestData\PermissionEx"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4); + var errors = converter.ConvertFile(targetFile, true); + + Assert.Equal(8, errors); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void CanConvertSingleFile() + { + const string beforeFileName = "SingleFile.wxs"; + const string afterFileName = "ConvertedSingleFile.wxs"; + var folder = TestData.Get(@"TestData\SingleFile"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4); + var errors = converter.ConvertFile(targetFile, true); + + Assert.Equal(9, errors); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void CanDetectReadOnlyOutputFile() + { + const string beforeFileName = "SingleFile.wxs"; + var folder = TestData.Get(@"TestData\SingleFile"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var info = new FileInfo(targetFile); + info.IsReadOnly = true; + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4); + var errors = converter.ConvertFile(targetFile, true); + + Assert.Single(messaging.Messages.Where(m => m.Id == 5/*WixConverter.ConverterTestType.UnauthorizedAccessException*/)); + } + } + + [Fact] + public void RetainsPreprocessorInstructions() + { + const string beforeFileName = "Preprocessor.wxs"; + const string afterFileName = "ConvertedPreprocessor.wxs"; + var folder = TestData.Get(@"TestData\Preprocessor"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var settingsFile = Path.Combine(folder, "wixcop.settings.xml"); + + var result = RunConversion(targetFile, settingsFile: settingsFile); + Assert.Equal(9, result.ExitCode); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void CanConvertQtExec() + { + const string beforeFileName = "v3.wxs"; + const string afterFileName = "v4_expected.wxs"; + var folder = TestData.Get(@"TestData\QtExec"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var result = RunConversion(targetFile); + Assert.Equal(13, result.ExitCode); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + EnsureFixed(targetFile); + } + } + + [Fact] + public void DetectUnconvertableQtExecCmdTimeout() + { + const string beforeFileName = "v3.wxs"; + const string afterFileName = "v4_expected.wxs"; + var folder = TestData.Get(@"TestData\QtExec.bad"); + + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(true); + var targetFile = Path.Combine(baseFolder, beforeFileName); + File.Copy(Path.Combine(folder, beforeFileName), Path.Combine(baseFolder, beforeFileName)); + + var result = RunConversion(targetFile); + + Assert.Equal(13, result.ExitCode); + Assert.Single(result.Messages.Where(message => message.ToString().EndsWith("(QtExecCmdTimeoutAmbiguous)"))); + + var expected = File.ReadAllText(Path.Combine(folder, afterFileName)).Replace("\r\n", "\n"); + var actual = File.ReadAllText(targetFile).Replace("\r\n", "\n"); + Assert.Equal(expected, actual); + + // still fails because QtExecCmdTimeoutAmbiguous is unfixable + var result2 = RunConversion(targetFile); + Assert.Equal(1, result2.ExitCode); + } + } + + private static WixRunnerResult RunConversion(string targetFile, bool fixErrors = true, string settingsFile = null) + { + var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider().AddConverter(); + + var exitCode = WixRunner.Execute(new[] + { + "convert", + fixErrors ? null : "--dry-run", + String.IsNullOrEmpty(settingsFile) ? null : "-set1" + settingsFile, + targetFile + }, serviceProvider, out var messages); + + return new WixRunnerResult { ExitCode = exitCode.Result, Messages = messages.ToArray() }; + } + + private static void EnsureFixed(string targetFile) + { + var messaging2 = new MockMessaging(); + var converter2 = new WixConverter(messaging2, 4); + var errors2 = converter2.ConvertFile(targetFile, true); + Assert.Equal(0, errors2); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/CustomActionFixture.cs b/src/wix/test/WixToolsetTest.Converters/CustomActionFixture.cs new file mode 100644 index 00000000..eafc171a --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/CustomActionFixture.cs @@ -0,0 +1,88 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class CustomActionFixture : BaseConverterFixture + { + [Fact] + public void CanConvertCustomAction() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(11, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertCustomActionScript() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " function() {", + " var x = 0;", + " return x;", + " }", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expectedScript = String.Join("\n", + "function() {", + " var x = 0;", + " return x;", + " }"); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + + var script = File.ReadAllText("Foo.js"); + Assert.Equal(expectedScript, script); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/CustomTableFixture.cs b/src/wix/test/WixToolsetTest.Converters/CustomTableFixture.cs new file mode 100644 index 00000000..2b81a863 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/CustomTableFixture.cs @@ -0,0 +1,363 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class CustomTableFixture : BaseConverterFixture + { + [Fact] + public void FixCustomTableCategoryAndModularization() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixCustomRowTextValue() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " Some value", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixCustomRowCdataValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixCustomRowWithoutValue() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CanConvertBundleCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Bundle); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertBundleCustomTableRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Bundle); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertMsiCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Msi); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanConvertMsiCustomTableRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " Row1", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, customTableTarget: CustomTableTarget.Msi); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(2, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanDetectAmbiguousCustomTableBootstrapperApplicationData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + + [Fact] + public void CanRemoveBootstrapperApplicationDataFromRealCustomTable() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(1, errors); + Assert.Equal(expected, actual); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/DependencyFixture.cs b/src/wix/test/WixToolsetTest.Converters/DependencyFixture.cs new file mode 100644 index 00000000..41ded927 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/DependencyFixture.cs @@ -0,0 +1,178 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class DependencyFixture : BaseConverterFixture + { + [Fact] + public void FixPackageDependencyProvides() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPackageDependencyRequires() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixPackageDependencyRequiresRef() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixBundleDependencyProvides() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/DirectoryFixture.cs b/src/wix/test/WixToolsetTest.Converters/DirectoryFixture.cs new file mode 100644 index 00000000..3c906320 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/DirectoryFixture.cs @@ -0,0 +1,92 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class DirectoryFixture : BaseConverterFixture + { + [Fact] + public void RemoveTargetDir() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixStandardDirectory() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/ExePackageFixture.cs b/src/wix/test/WixToolsetTest.Converters/ExePackageFixture.cs new file mode 100644 index 00000000..0ee8d065 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/ExePackageFixture.cs @@ -0,0 +1,49 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ExePackageFixture : BaseConverterFixture + { + [Fact] + public void CanConvertExePackageCommandToArguments() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/FeatureFixture.cs b/src/wix/test/WixToolsetTest.Converters/FeatureFixture.cs new file mode 100644 index 00000000..1df94a81 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/FeatureFixture.cs @@ -0,0 +1,110 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class FeatureFixture : BaseConverterFixture + { + [Fact] + public void FixAllowAttributes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixDisallowAttributes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void RemoveDeprecatedAllowAdvertiseAttributes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs b/src/wix/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs new file mode 100644 index 00000000..a101019b --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/FirewallExtensionFixture.cs @@ -0,0 +1,47 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class FirewallExtensionFixture : BaseConverterFixture + { + [Fact] + public void FixRemoteAddressValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " 127.0.0.1", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/FormatFixture.cs b/src/wix/test/WixToolsetTest.Converters/FormatFixture.cs new file mode 100644 index 00000000..739fba66 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/FormatFixture.cs @@ -0,0 +1,117 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class FormatFixture : BaseConverterFixture + { + [Fact] + public void CanFixWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4, null, null); + + var errors = converter.FormatDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(5, errors); + } + + [Fact] + public void CanPreserveNewLines() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + "", + " ", + "", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + "", + " ", + "", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4, null, null); + + var conversions = converter.FormatDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(4, conversions); + } + + [Fact] + public void CanFormatWithNewLineAtEndOfFile() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + "", + " ", + "", + " ", + "", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + "", + " ", + "", + " ", + "", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 4, null, null); + + var conversions = converter.FormatDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(3, conversions); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/IncludeFixture.cs b/src/wix/test/WixToolsetTest.Converters/IncludeFixture.cs new file mode 100644 index 00000000..2fd8244f --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/IncludeFixture.cs @@ -0,0 +1,68 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class IncludeFixture : BaseConverterFixture + { + [Fact] + public void EnsureNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = new[] + { + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixNamespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + ""); + + var expected = new[] + { + "", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs b/src/wix/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs new file mode 100644 index 00000000..b6bb8a40 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/Mocks/MockCoreServiceProvider.cs @@ -0,0 +1,51 @@ +// 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 WixToolsetTest.Converters.Mocks +{ + using System; + using System.Collections.Generic; + using WixToolset.Extensibility.Services; + + public class MockCoreServiceProvider : IWixToolsetCoreServiceProvider + { + public Dictionary, object>> CreationFunctions { get; } = new Dictionary, object>>(); + + public Dictionary Singletons { get; } = new Dictionary() + { + { typeof(IMessaging), new MockMessaging() } + }; + + public void AddService(Type serviceType, Func, object> creationFunction) => this.CreationFunctions.Add(serviceType, creationFunction); + + public void AddService(Func, T> creationFunction) where T : class => this.AddService(typeof(T), creationFunction); + + public T GetService() where T : class => this.TryGetService(typeof(T), out var obj) ? (T)obj : null; + + public object GetService(Type serviceType) => this.TryGetService(serviceType, out var service) ? service : null; + + public bool TryGetService(Type serviceType, out object service) + { + if (!this.Singletons.TryGetValue(serviceType, out service)) + { + if (this.CreationFunctions.TryGetValue(serviceType, out var creationFunction)) + { + service = creationFunction(this, this.Singletons); + } + } + + return service != null; + } + + public bool TryGetService(out T service) where T : class + { + service = null; + + if (this.TryGetService(typeof(T), out var obj)) + { + service = (T)obj; + } + + return service != null; + } + } +} \ No newline at end of file diff --git a/src/wix/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs b/src/wix/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs new file mode 100644 index 00000000..77821a1c --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/Mocks/MockMessaging.cs @@ -0,0 +1,39 @@ +// 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 WixToolsetTest.Converters.Mocks +{ + using System; + using System.Collections.Generic; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + + public class MockMessaging : IMessaging + { + public List Messages { get; } = new List(); + + public bool EncounteredError { get; private set; } + + public int LastErrorNumber { get; } + + public bool ShowVerboseMessages { get; set; } + + public bool SuppressAllWarnings { get; set; } + + public bool WarningsAsError { get; set; } + + public void ElevateWarningMessage(int warningNumber) => throw new NotImplementedException(); + + public void SetListener(IMessageListener listener) => throw new NotImplementedException(); + + public void SuppressWarningMessage(int warningNumber) => throw new NotImplementedException(); + + public void Write(Message message) + { + this.Messages.Add(message); + this.EncounteredError |= message.Level == MessageLevel.Error; + } + + public void Write(string message, bool verbose = false) => throw new NotImplementedException(); + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/ProductPackageFixture.cs b/src/wix/test/WixToolsetTest.Converters/ProductPackageFixture.cs new file mode 100644 index 00000000..e01b9789 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/ProductPackageFixture.cs @@ -0,0 +1,278 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.IO; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolset.Core.TestPackage; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class ProductPackageFixture : BaseConverterFixture + { + [Fact] + public void FixesCompressedWhenYes() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void FixesCompressedWhenNo() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void FixesCompressedWhenOmitted() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + private static void AssertSuccess(string input, int expectedErrorCount, string[] expected) + { + var document = XDocument.Parse(input, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(expectedErrorCount, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixesInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesDefaultInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesImplicitInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void FixesNonDefaultInstallerVersion() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 3, expected); + } + + [Fact] + public void FixesLimitedInstallerPrivileges() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void FixesElevatedInstallerPrivileges() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "" + }; + + AssertSuccess(parse, 4, expected); + } + + [Fact] + public void CanDecompileAndRecompile() + { + using (var fs = new DisposableFileSystem()) + { + var baseFolder = fs.GetFolder(); + var intermediateFolder = Path.Combine(baseFolder, "obj"); + var decompiledWxsPath = Path.Combine(baseFolder, "TypicalV3.wxs"); + + var folder = TestData.Get(@"TestData\PackageSummaryInformation"); + var v3msiPath = Path.Combine(folder, "TypicalV3.msi"); + var result = WixRunner.Execute(new[] + { + "decompile", v3msiPath, + "-intermediateFolder", intermediateFolder, + "-o", decompiledWxsPath + }); + + result.AssertSuccess(); + + var v4msiPath = Path.Combine(intermediateFolder, "TypicalV4.msi"); + result = WixRunner.Execute(new[] + { + "build", decompiledWxsPath, + "-arch", "x64", + "-intermediateFolder", intermediateFolder, + "-o", v4msiPath + }); + + result.AssertSuccess(); + + Assert.True(File.Exists(v4msiPath)); + + var v3results = Query.QueryDatabase(v3msiPath, new[] { "_SummaryInformation", "Property" }); + var v4results = Query.QueryDatabase(v4msiPath, new[] { "_SummaryInformation", "Property" }); + WixAssert.CompareLineByLine(v3results, v4results); + } + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/PropertyFixture.cs b/src/wix/test/WixToolsetTest.Converters/PropertyFixture.cs new file mode 100644 index 00000000..e50a6518 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/PropertyFixture.cs @@ -0,0 +1,108 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class PropertyFixture : BaseConverterFixture + { + [Fact] + public void CanFixCdataWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(1, errors); + } + + [Fact] + public void CanFixCdataWithWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(1, errors); + } + + [Fact] + public void CanKeepCdataWithOnlyWhitespace() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + var errors = converter.ConvertDocument(document); + + var actual = UnformattedDocumentString(document); + + Assert.Equal(expected, actual); + Assert.Equal(1, errors); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/RegistryFixture.cs b/src/wix/test/WixToolsetTest.Converters/RegistryFixture.cs new file mode 100644 index 00000000..405f5416 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/RegistryFixture.cs @@ -0,0 +1,54 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class RegistryFixture : BaseConverterFixture + { + [Fact] + public void FixRegistryKeyAction() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/RemotePayloadFixture.cs b/src/wix/test/WixToolsetTest.Converters/RemotePayloadFixture.cs new file mode 100644 index 00000000..b2640e13 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/RemotePayloadFixture.cs @@ -0,0 +1,104 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class RemotePayloadFixture : BaseConverterFixture + { + [Fact] + public void CanConvertExePackageRemotePayload() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void CanConvertMsuPackageRemotePayload() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(5, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/SequenceFixture.cs b/src/wix/test/WixToolsetTest.Converters/SequenceFixture.cs new file mode 100644 index 00000000..ec6c709b --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/SequenceFixture.cs @@ -0,0 +1,49 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class SequenceFixture : BaseConverterFixture + { + [Fact] + public void FixCondition() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " NOT Installed", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(2, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/TagFixture.cs b/src/wix/test/WixToolsetTest.Converters/TagFixture.cs new file mode 100644 index 00000000..5e07c83b --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TagFixture.cs @@ -0,0 +1,111 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class TagFixture : BaseConverterFixture + { + [Fact] + public void FixTagExtension() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixTagExtensionDeprecations() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(7, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixTagExtensionTagRef() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi b/src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi new file mode 100644 index 00000000..0d7e1b21 Binary files /dev/null and b/src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.msi differ diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs new file mode 100644 index 00000000..8c5027b4 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/PackageSummaryInformation/TypicalV3.wxs @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs new file mode 100644 index 00000000..9a739052 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v3.wxs @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs new file mode 100644 index 00000000..6bf3c1ea --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/PermissionEx/v4_expected.wxs @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs new file mode 100644 index 00000000..8188d900 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/ConvertedPreprocessor.wxs @@ -0,0 +1,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs new file mode 100644 index 00000000..2eb908c2 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/Preprocessor.wxs @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml b/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml new file mode 100644 index 00000000..9d3ad496 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/Preprocessor/wixcop.settings.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs new file mode 100644 index 00000000..b0fcf9c9 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v3.wxs @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs new file mode 100644 index 00000000..95d2f618 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec.bad/v4_expected.wxs @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs new file mode 100644 index 00000000..8d81a758 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v3.wxs @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs new file mode 100644 index 00000000..f24d3f8f --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/QtExec/v4_expected.wxs @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs new file mode 100644 index 00000000..5bcdaf59 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/ConvertedSingleFile.wxs @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs b/src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs new file mode 100644 index 00000000..310ae811 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/TestData/SingleFile/SingleFile.wxs @@ -0,0 +1,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/wix/test/WixToolsetTest.Converters/UtilExtensionFixture.cs b/src/wix/test/WixToolsetTest.Converters/UtilExtensionFixture.cs new file mode 100644 index 00000000..10450c68 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/UtilExtensionFixture.cs @@ -0,0 +1,190 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class UtilExtensionFixture : BaseConverterFixture + { + [Fact] + public void FixCloseAppsCondition() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " a<>b", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixXmlConfigValue() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " a<>b", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void WarnsOnAllRegistryValueSearches() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(4, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + + [Fact] + public void FixXmlConfigValueCData() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " b]]>", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void FixQueryOsPropertyRefs() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(6, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/VariableFixture.cs b/src/wix/test/WixToolsetTest.Converters/VariableFixture.cs new file mode 100644 index 00000000..b7b7388f --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/VariableFixture.cs @@ -0,0 +1,86 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class VariableFixture : BaseConverterFixture + { + [Fact] + public void FixFormattedType() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void DoesntFixFormattedTypeFromV4() + { + var parse = String.Join(Environment.NewLine, + "", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(0, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs b/src/wix/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs new file mode 100644 index 00000000..16a68895 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/Wix4ConversionFixture.cs @@ -0,0 +1,54 @@ +// 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 WixToolsetTest.Converters +{ + using System; + using System.Xml.Linq; + using WixBuildTools.TestSupport; + using WixToolset.Converters; + using WixToolsetTest.Converters.Mocks; + using Xunit; + + public class Wix4ConversionFixture : BaseConverterFixture + { + [Fact] + public void DoesNotAddFileId() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo); + + var messaging = new MockMessaging(); + var converter = new WixConverter(messaging, 2, null, null); + + var errors = converter.ConvertDocument(document); + Assert.Equal(1, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} diff --git a/src/wix/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj b/src/wix/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj new file mode 100644 index 00000000..29b02b95 --- /dev/null +++ b/src/wix/test/WixToolsetTest.Converters/WixToolsetTest.Converters.csproj @@ -0,0 +1,31 @@ + + + + + + netcoreapp3.1 + false + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/version.json b/version.json deleted file mode 100644 index 5f857771..00000000 --- a/version.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "version": "4.0", - "publicReleaseRefSpec": [ - "^refs/heads/master$" - ], - "cloudBuild": { - "buildNumber": { - "enabled": true - } - } -} -- cgit v1.2.3-55-g6feb