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