Add ModelMetadata.HtmlEncode property

dougbu · dougbu · commit 2b12791aee4f · 2014-07-17T12:17:17.000-07:00
- use new `ModelMetadata.HtmlEncode` property in HTML helpers
 - conditionally in default HTML display and editor object templates (e.g.
   `@Html.DisplayFor()`) when value is non-null and the template is invoked
   with template depth greater than 1
 - unconditionally in `@Html.DisplayText()` and `@Html.DisplayTextFor()`
- test new property and its use

Also test `DisplayTextExtensions`
- unit test gap
diff --git a/src/System.Web.Mvc/CachedDataAnnotationsModelMetadata.cs b/src/System.Web.Mvc/CachedDataAnnotationsModelMetadata.cs
@@ -123,6 +123,13 @@ protected override bool ComputeHideSurroundingHtml()
                        : base.ComputeHideSurroundingHtml();
         }
 
+        protected override bool ComputeHtmlEncode()
+        {
+            return (PrototypeCache.DisplayFormat != null)
+                ? PrototypeCache.DisplayFormat.HtmlEncode
+                : base.ComputeHtmlEncode();
+        }
+
         protected override bool ComputeIsReadOnly()
         {
             if (PrototypeCache.Editable != null)
diff --git a/src/System.Web.Mvc/CachedModelMetadata.cs b/src/System.Web.Mvc/CachedModelMetadata.cs
@@ -20,6 +20,7 @@ public abstract class CachedModelMetadata<TPrototypeCache> : ModelMetadata
         private string _editFormatString;
         private bool _hasNonDefaultEditFormat;
         private bool _hideSurroundingHtml;
+        private bool _htmlEncode;
         private bool _isReadOnly;
         private bool _isRequired;
         private string _nullDisplayText;
@@ -38,6 +39,7 @@ public abstract class CachedModelMetadata<TPrototypeCache> : ModelMetadata
         private bool _editFormatStringComputed;
         private bool _hasNonDefaultEditFormatComputed;
         private bool _hideSurroundingHtmlComputed;
+        private bool _htmlEncodeComputed;
         private bool _isReadOnlyComputed;
         private bool _isRequiredComputed;
         private bool _nullDisplayTextComputed;
@@ -207,6 +209,24 @@ public sealed override bool HideSurroundingHtml
             }
         }
 
+        public sealed override bool HtmlEncode
+        {
+            get
+            {
+                if (!_htmlEncodeComputed)
+                {
+                    _htmlEncode = ComputeHtmlEncode();
+                    _htmlEncodeComputed = true;
+                }
+                return _htmlEncode;
+            }
+            set
+            {
+                _htmlEncode = value;
+                _htmlEncodeComputed = true;
+            }
+        }
+
         public sealed override bool IsReadOnly
         {
             get
@@ -421,6 +441,11 @@ protected virtual bool ComputeHideSurroundingHtml()
             return base.HideSurroundingHtml;
         }
 
+        protected virtual bool ComputeHtmlEncode()
+        {
+            return base.HtmlEncode;
+        }
+
         protected virtual bool ComputeIsReadOnly()
         {
             return base.IsReadOnly;
diff --git a/src/System.Web.Mvc/DataAnnotationsModelMetadataProvider.cs b/src/System.Web.Mvc/DataAnnotationsModelMetadataProvider.cs
@@ -121,6 +121,7 @@ private static void SetFromDataTypeAndDisplayAttributes(DataAnnotationsModelMeta
                 result.NullDisplayText = displayFormatAttribute.NullDisplayText;
                 result.DisplayFormatString = displayFormatAttribute.DataFormatString;
                 result.ConvertEmptyStringToNull = displayFormatAttribute.ConvertEmptyStringToNull;
+                result.HtmlEncode = displayFormatAttribute.HtmlEncode;
 
                 if (displayFormatAttribute.ApplyFormatInEditMode)
                 {
diff --git a/src/System.Web.Mvc/Html/DefaultDisplayTemplates.cs b/src/System.Web.Mvc/Html/DefaultDisplayTemplates.cs
@@ -174,7 +174,13 @@ internal static string ObjectTemplate(HtmlHelper html, TemplateHelpers.TemplateH
             if (templateInfo.TemplateDepth > 1)
             {
                 // DDB #224751
-                return modelMetadata.SimpleDisplayText;
+                string text = modelMetadata.SimpleDisplayText;
+                if (modelMetadata.HtmlEncode)
+                {
+                    text = html.Encode(text);
+                }
+
+                return text;
             }
 
             foreach (ModelMetadata propertyMetadata in modelMetadata.Properties.Where(pm => ShouldShow(pm, templateInfo)))
diff --git a/src/System.Web.Mvc/Html/DefaultEditorTemplates.cs b/src/System.Web.Mvc/Html/DefaultEditorTemplates.cs
@@ -230,8 +230,19 @@ internal static string ObjectTemplate(HtmlHelper html, TemplateHelpers.TemplateH
 
             if (templateInfo.TemplateDepth > 1)
             {
+                if (modelMetadata.Model == null)
+                {
+                    return modelMetadata.NullDisplayText;
+                }
+
                 // DDB #224751
-                return modelMetadata.Model == null ? modelMetadata.NullDisplayText : modelMetadata.SimpleDisplayText;
+                string text = modelMetadata.SimpleDisplayText;
+                if (modelMetadata.HtmlEncode)
+                {
+                    text = html.Encode(text);
+                }
+
+                return text;
             }
 
             foreach (ModelMetadata propertyMetadata in modelMetadata.Properties.Where(pm => ShouldShow(pm, templateInfo)))
diff --git a/src/System.Web.Mvc/Html/DisplayTextExtensions.cs b/src/System.Web.Mvc/Html/DisplayTextExtensions.cs
@@ -9,18 +9,24 @@ public static class DisplayTextExtensions
     {
         public static MvcHtmlString DisplayText(this HtmlHelper html, string name)
         {
-            return DisplayTextHelper(ModelMetadata.FromStringExpression(name, html.ViewContext.ViewData));
+            return DisplayTextHelper(html, ModelMetadata.FromStringExpression(name, html.ViewContext.ViewData));
         }
 
         [SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures", Justification = "This is an appropriate nesting of generic types")]
         public static MvcHtmlString DisplayTextFor<TModel, TResult>(this HtmlHelper<TModel> html, Expression<Func<TModel, TResult>> expression)
         {
-            return DisplayTextHelper(ModelMetadata.FromLambdaExpression(expression, html.ViewData));
+            return DisplayTextHelper(html, ModelMetadata.FromLambdaExpression(expression, html.ViewData));
         }
 
-        private static MvcHtmlString DisplayTextHelper(ModelMetadata metadata)
+        private static MvcHtmlString DisplayTextHelper(HtmlHelper html, ModelMetadata metadata)
         {
-            return MvcHtmlString.Create(metadata.SimpleDisplayText);
+            string text = metadata.SimpleDisplayText;
+            if (metadata.HtmlEncode)
+            {
+                text = html.Encode(text);
+            }
+
+            return MvcHtmlString.Create(text);
         }
     }
 }
diff --git a/src/System.Web.Mvc/ModelMetadata.cs b/src/System.Web.Mvc/ModelMetadata.cs
@@ -28,6 +28,7 @@ public class ModelMetadata
         /// </summary>
         private Dictionary<string, object> _additionalValues = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
         private bool _convertEmptyStringToNull = true;
+        private bool _htmlEncode = true;
         private bool _isRequired;
         private object _model;
         private Func<object> _modelAccessor;
@@ -96,6 +97,12 @@ public virtual bool ConvertEmptyStringToNull
 
         public virtual bool HideSurroundingHtml { get; set; }
 
+        public virtual bool HtmlEncode
+        {
+            get { return _htmlEncode; }
+            set { _htmlEncode = value; }
+        }
+
         public virtual bool IsComplexType
         {
             get { return !(TypeDescriptor.GetConverter(ModelType).CanConvertFrom(typeof(string))); }
diff --git a/test/System.Web.Mvc.Test/Html/Test/DefaultDisplayTemplatesTest.cs b/test/System.Web.Mvc.Test/Html/Test/DefaultDisplayTemplatesTest.cs
@@ -454,14 +454,20 @@ public void ObjectTemplateDisplaysNullDisplayTextWhenObjectIsNull()
             Assert.Equal(metadata.NullDisplayText, result);
         }
 
-        [Fact]
-        public void ObjectTemplateDisplaysSimpleDisplayTextWhenTemplateDepthGreaterThanOne()
+        [Theory]
+        [PropertyData("DisplayTextData", PropertyType = typeof(DisplayTextExtensionsTest))]
+        public void ObjectTemplateDisplaysSimpleDisplayTextWhenTemplateDepthGreaterThanOne(
+            string simpleDisplayText,
+            bool htmlEncode,
+            string expectedResult)
         {
             // Arrange
             ObjectTemplateModel model = new ObjectTemplateModel();
             HtmlHelper html = MakeHtmlHelper<ObjectTemplateModel>(model);
             ModelMetadata metadata = ModelMetadataProviders.Current.GetMetadataForType(() => model, typeof(ObjectTemplateModel));
-            metadata.SimpleDisplayText = "Simple Display Text";
+            metadata.SimpleDisplayText = simpleDisplayText;
+            metadata.HtmlEncode = htmlEncode;
+
             html.ViewData.ModelMetadata = metadata;
             html.ViewData.TemplateInfo.VisitedObjects.Add("foo");
             html.ViewData.TemplateInfo.VisitedObjects.Add("bar");
@@ -470,7 +476,7 @@ public void ObjectTemplateDisplaysSimpleDisplayTextWhenTemplateDepthGreaterThanO
             string result = DefaultDisplayTemplates.ObjectTemplate(html, SpyCallback);
 
             // Assert
-            Assert.Equal(metadata.SimpleDisplayText, result);
+            Assert.Equal(expectedResult, result);
         }
 
         [Fact]
diff --git a/test/System.Web.Mvc.Test/Html/Test/DefaultEditorTemplatesTest.cs b/test/System.Web.Mvc.Test/Html/Test/DefaultEditorTemplatesTest.cs
@@ -697,24 +697,30 @@ public void ObjectTemplateDisplaysNullDisplayTextWithNullModelAndTemplateDepthGr
             Assert.Equal(metadata.NullDisplayText, result);
         }
 
-        [Fact]
-        public void ObjectTemplateDisplaysSimpleDisplayTextWithNonNullModelTemplateDepthGreaterThanOne()
+        [Theory]
+        [PropertyData("DisplayTextData", PropertyType = typeof(DisplayTextExtensionsTest))]
+        public void ObjectTemplateDisplaysSimpleDisplayTextWithNonNullModelTemplateDepthGreaterThanOne(
+            string simpleDisplayText,
+            bool htmlEncode,
+            string expectedResult)
         {
             // Arrange
             ObjectTemplateModel model = new ObjectTemplateModel();
             HtmlHelper html = MakeHtmlHelper<ObjectTemplateModel>(model);
             ModelMetadata metadata = ModelMetadataProviders.Current.GetMetadataForType(() => model, typeof(ObjectTemplateModel));
             html.ViewData.ModelMetadata = metadata;
             metadata.NullDisplayText = "Null Display Text";
-            metadata.SimpleDisplayText = "Simple Display Text";
+            metadata.SimpleDisplayText = simpleDisplayText;
+            metadata.HtmlEncode = htmlEncode;
+
             html.ViewData.TemplateInfo.VisitedObjects.Add("foo");
             html.ViewData.TemplateInfo.VisitedObjects.Add("bar");
 
             // Act
             string result = DefaultEditorTemplates.ObjectTemplate(html, SpyCallback);
 
             // Assert
-            Assert.Equal(metadata.SimpleDisplayText, result);
+            Assert.Equal(expectedResult, result);
         }
 
         // PasswordTemplate
diff --git a/test/System.Web.Mvc.Test/Html/Test/DisplayTextExtensionsTest.cs b/test/System.Web.Mvc.Test/Html/Test/DisplayTextExtensionsTest.cs
diff --git a/test/System.Web.Mvc.Test/System.Web.Mvc.Test.csproj b/test/System.Web.Mvc.Test/System.Web.Mvc.Test.csproj
diff --git a/test/System.Web.Mvc.Test/Test/DataAnnotationsModelMetadataProviderTestBase.cs b/test/System.Web.Mvc.Test/Test/DataAnnotationsModelMetadataProviderTestBase.cs
diff --git a/test/System.Web.Mvc.Test/Test/ModelMetadataTest.cs b/test/System.Web.Mvc.Test/Test/ModelMetadataTest.cs

Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,13 @@ protected override bool ComputeHideSurroundingHtml()`
`123`	`123`	`: base.ComputeHideSurroundingHtml();`
`124`	`124`	`}`
`125`	`125`
	`126`	`+ protected override bool ComputeHtmlEncode()`
	`127`	`+ {`
	`128`	`+ return (PrototypeCache.DisplayFormat != null)`
	`129`	`+ ? PrototypeCache.DisplayFormat.HtmlEncode`
	`130`	`+ : base.ComputeHtmlEncode();`
	`131`	`+ }`
	`132`	`+`
`126`	`133`	`protected override bool ComputeIsReadOnly()`
`127`	`134`	`{`
`128`	`135`	`if (PrototypeCache.Editable != null)`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,7 @@ private static void SetFromDataTypeAndDisplayAttributes(DataAnnotationsModelMeta`
`121`	`121`	`result.NullDisplayText = displayFormatAttribute.NullDisplayText;`
`122`	`122`	`result.DisplayFormatString = displayFormatAttribute.DataFormatString;`
`123`	`123`	`result.ConvertEmptyStringToNull = displayFormatAttribute.ConvertEmptyStringToNull;`
	`124`	`+ result.HtmlEncode = displayFormatAttribute.HtmlEncode;`
`124`	`125`
`125`	`126`	`if (displayFormatAttribute.ApplyFormatInEditMode)`
`126`	`127`	`{`
Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,13 @@ internal static string ObjectTemplate(HtmlHelper html, TemplateHelpers.TemplateH`
`174`	`174`	`if (templateInfo.TemplateDepth > 1)`
`175`	`175`	`{`
`176`	`176`	`// DDB #224751`
`177`		`- return modelMetadata.SimpleDisplayText;`
	`177`	`+ string text = modelMetadata.SimpleDisplayText;`
	`178`	`+ if (modelMetadata.HtmlEncode)`
	`179`	`+ {`
	`180`	`+ text = html.Encode(text);`
	`181`	`+ }`
	`182`	`+`
	`183`	`+ return text;`
`178`	`184`	`}`
`179`	`185`
`180`	`186`	`foreach (ModelMetadata propertyMetadata in modelMetadata.Properties.Where(pm => ShouldShow(pm, templateInfo)))`
Original file line number	Diff line number	Diff line change
`@@ -9,18 +9,24 @@ public static class DisplayTextExtensions`
`9`	`9`	`{`
`10`	`10`	`public static MvcHtmlString DisplayText(this HtmlHelper html, string name)`
`11`	`11`	`{`
`12`		`- return DisplayTextHelper(ModelMetadata.FromStringExpression(name, html.ViewContext.ViewData));`
	`12`	`+ return DisplayTextHelper(html, ModelMetadata.FromStringExpression(name, html.ViewContext.ViewData));`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`[SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures", Justification = "This is an appropriate nesting of generic types")]`
`16`	`16`	`public static MvcHtmlString DisplayTextFor<TModel, TResult>(this HtmlHelper<TModel> html, Expression<Func<TModel, TResult>> expression)`
`17`	`17`	`{`
`18`		`- return DisplayTextHelper(ModelMetadata.FromLambdaExpression(expression, html.ViewData));`
	`18`	`+ return DisplayTextHelper(html, ModelMetadata.FromLambdaExpression(expression, html.ViewData));`
`19`	`19`	`}`
`20`	`20`
`21`		`- private static MvcHtmlString DisplayTextHelper(ModelMetadata metadata)`
	`21`	`+ private static MvcHtmlString DisplayTextHelper(HtmlHelper html, ModelMetadata metadata)`
`22`	`22`	`{`
`23`		`- return MvcHtmlString.Create(metadata.SimpleDisplayText);`
	`23`	`+ string text = metadata.SimpleDisplayText;`
	`24`	`+ if (metadata.HtmlEncode)`
	`25`	`+ {`
	`26`	`+ text = html.Encode(text);`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ return MvcHtmlString.Create(text);`
`24`	`30`	`}`
`25`	`31`	`}`
`26`	`32`	`}`