Add back IHtmlString to System.Web.HttpUtility (#85673)

* Add back IHtmlString to System.Web.HttpUtility * Update src/libraries/System.Web.HttpUtility/tests/HttpUtility/HttpUtilityTest.cs Co-authored-by: Miha Zupan <[email protected]> --------- Co-authored-by: Miha Zupan <[email protected]>
dotnet · May 3, 2023 · 29d8a16 · 29d8a16
1 parent 27e725d
commit 29d8a16
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 1 deletion.
diff --git a/src/libraries/System.Web.HttpUtility/ref/System.Web.HttpUtility.cs b/src/libraries/System.Web.HttpUtility/ref/System.Web.HttpUtility.cs
@@ -65,4 +65,8 @@ public static void HtmlEncode(string? s, System.IO.TextWriter output) { }
         [return: System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute("str")]
         public static string? UrlPathEncode(string? str) { throw null; }
     }
+    public partial interface IHtmlString
+    {
+        string ToHtmlString();
+    }
 }
diff --git a/src/libraries/System.Web.HttpUtility/src/System.Web.HttpUtility.csproj b/src/libraries/System.Web.HttpUtility/src/System.Web.HttpUtility.csproj
@@ -4,6 +4,7 @@
     <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="System\Web\IHtmlString.cs" />
     <Compile Include="System\Web\HttpUtility.cs" />
     <Compile Include="System\Web\Util\HttpEncoder.cs" />
     <Compile Include="System\Web\Util\HttpEncoderUtility.cs" />

diff --git a/src/libraries/System.Web.HttpUtility/src/System/Web/HttpUtility.cs b/src/libraries/System.Web.HttpUtility/src/System/Web/HttpUtility.cs
@@ -143,7 +143,12 @@ public static NameValueCollection ParseQueryString(string query, Encoding encodi
 
         [return: NotNullIfNotNull(nameof(value))]
         public static string? HtmlEncode(object? value) =>
-            value == null ? null : HtmlEncode(Convert.ToString(value, CultureInfo.CurrentCulture) ?? string.Empty);
+            value switch
+            {
+                null => null,
+                IHtmlString ihs => ihs.ToHtmlString() ?? string.Empty,
+                _ => HtmlEncode(Convert.ToString(value, CultureInfo.CurrentCulture) ?? string.Empty),
+            };
 
         public static void HtmlEncode(string? s, TextWriter output) => HttpEncoder.HtmlEncode(s, output);
 

diff --git a/src/libraries/System.Web.HttpUtility/src/System/Web/IHtmlString.cs b/src/libraries/System.Web.HttpUtility/src/System/Web/IHtmlString.cs
@@ -0,0 +1,13 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Web
+{
+    /// <summary>Represents an HTML-encoded string that should not be encoded again.</summary>
+    public interface IHtmlString
+    {
+        /// <summary>Returns an HTML-encoded string.</summary>
+        /// <returns>An HTML-encoded string.</returns>
+        string ToHtmlString();
+    }
+}
diff --git a/src/libraries/System.Web.HttpUtility/tests/HttpUtility/HttpUtilityTest.cs b/src/libraries/System.Web.HttpUtility/tests/HttpUtility/HttpUtilityTest.cs
@@ -284,6 +284,20 @@ public void HtmlEncode_TextWriter_null()
             });
         }
 
+        [Fact]
+        public void HtmlEncode_IHtmlString_UseToHtmlString()
+        {
+            Assert.Equal(string.Empty, HttpUtility.HtmlEncode(new ActionHtmlString(() => null)));
+            Assert.Equal(string.Empty, HttpUtility.HtmlEncode(new ActionHtmlString(() => string.Empty)));
+            Assert.Equal("<", HttpUtility.HtmlEncode(new ActionHtmlString(() => "<")));
+            Assert.Throws<FormatException>(() => HttpUtility.HtmlEncode(new ActionHtmlString(() => throw new FormatException())));
+        }
+
+        private sealed class ActionHtmlString(Func<string> toHtmlString) : IHtmlString
+        {
+            public string ToHtmlString() => toHtmlString();
+        }
+
         #endregion HtmlEncode
 
         #region JavaScriptStringEncode