1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
namespace System.Web.ModelBinding {
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
public class ModelMetadata {
public const int DefaultOrder = 10000;
// Explicit backing store for the things we want initialized by default, so don't have to call
// the protected virtual setters of an auto-generated property
private Dictionary<string, object> _additionalValues = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
private readonly Type _containerType;
private bool _convertEmptyStringToNull = true;
private bool _isRequired;
private object _model;
private Func<object> _modelAccessor;
private readonly Type _modelType;
private int _order = DefaultOrder;
private IEnumerable<ModelMetadata> _properties;
private readonly string _propertyName;
private Type _realModelType;
private bool _requestValidationEnabled = true;
private bool _showForDisplay = true;
private bool _showForEdit = true;
private string _simpleDisplayText;
public ModelMetadata(ModelMetadataProvider provider, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName) {
if (provider == null) {
throw new ArgumentNullException("provider");
}
if (modelType == null) {
throw new ArgumentNullException("modelType");
}
Provider = provider;
_containerType = containerType;
_isRequired = !TypeHelpers.TypeAllowsNullValue(modelType);
_modelAccessor = modelAccessor;
_modelType = modelType;
_propertyName = propertyName;
}
public virtual Dictionary<string, object> AdditionalValues {
get {
return _additionalValues;
}
}
public Type ContainerType {
get {
return _containerType;
}
}
public virtual bool ConvertEmptyStringToNull {
get {
return _convertEmptyStringToNull;
}
set {
_convertEmptyStringToNull = value;
}
}
public virtual string DataTypeName {
get;
set;
}
public virtual string Description {
get;
set;
}
public virtual string DisplayFormatString {
get;
set;
}
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods", Justification = "The method is a delegating helper to choose among multiple property values")]
public virtual string DisplayName {
get;
set;
}
public virtual string EditFormatString {
get;
set;
}
public virtual bool HideSurroundingHtml {
get;
set;
}
public virtual bool IsComplexType {
get {
return !(TypeDescriptor.GetConverter(ModelType).CanConvertFrom(typeof(string)));
}
}
public bool IsNullableValueType {
get {
return TypeHelpers.IsNullableValueType(ModelType);
}
}
public virtual bool IsReadOnly {
get;
set;
}
public virtual bool IsRequired {
get {
return _isRequired;
}
set {
_isRequired = value;
}
}
public object Model {
get {
if (_modelAccessor != null) {
_model = _modelAccessor();
_modelAccessor = null;
}
return _model;
}
set {
_model = value;
_modelAccessor = null;
_properties = null;
_realModelType = null;
}
}
public Type ModelType {
get {
return _modelType;
}
}
public virtual string NullDisplayText {
get;
set;
}
public virtual int Order {
get {
return _order;
}
set {
_order = value;
}
}
public virtual IEnumerable<ModelMetadata> Properties {
get {
if (_properties == null) {
_properties = Provider.GetMetadataForProperties(Model, RealModelType).OrderBy(m => m.Order);
}
return _properties;
}
}
public string PropertyName {
get {
return _propertyName;
}
}
protected ModelMetadataProvider Provider {
get;
set;
}
internal Type RealModelType {
get {
if (_realModelType == null) {
_realModelType = ModelType;
// Don't call GetType() if the model is Nullable<T>, because it will
// turn Nullable<T> into T for non-null values
if (Model != null && !TypeHelpers.IsNullableValueType(ModelType)) {
_realModelType = Model.GetType();
}
}
return _realModelType;
}
}
public virtual bool RequestValidationEnabled {
get {
return _requestValidationEnabled;
}
set {
_requestValidationEnabled = value;
}
}
public virtual string ShortDisplayName {
get;
set;
}
public virtual bool ShowForDisplay {
get {
return _showForDisplay;
}
set {
_showForDisplay = value;
}
}
public virtual bool ShowForEdit {
get {
return _showForEdit;
}
set {
_showForEdit = value;
}
}
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods", Justification = "This property delegates to the method when the user has not yet set a simple display text value.")]
public virtual string SimpleDisplayText {
get {
if (_simpleDisplayText == null) {
_simpleDisplayText = GetSimpleDisplayText();
}
return _simpleDisplayText;
}
set {
_simpleDisplayText = value;
}
}
public virtual string TemplateHint {
get;
set;
}
public virtual string Watermark {
get;
set;
}
#if UNDEF
[SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures", Justification = "This is an appropriate nesting of generic types")]
public static ModelMetadata FromLambdaExpression<TParameter, TValue>(Expression<Func<TParameter, TValue>> expression,
ViewDataDictionary<TParameter> viewData) {
return FromLambdaExpression(expression, viewData, metadataProvider: null);
}
internal static ModelMetadata FromLambdaExpression<TParameter, TValue>(Expression<Func<TParameter, TValue>> expression,
ViewDataDictionary<TParameter> viewData,
ModelMetadataProvider metadataProvider) {
if (expression == null) {
throw new ArgumentNullException("expression");
}
if (viewData == null) {
throw new ArgumentNullException("viewData");
}
string propertyName = null;
Type containerType = null;
bool legalExpression = false;
// Need to verify the expression is valid; it needs to at least end in something
// that we can convert to a meaningful string for model binding purposes
switch (expression.Body.NodeType) {
// ArrayIndex always means a single-dimensional indexer; multi-dimensional indexer is a method call to Get()
case ExpressionType.ArrayIndex:
legalExpression = true;
break;
// Only legal method call is a single argument indexer/DefaultMember call
case ExpressionType.Call:
legalExpression = ExpressionHelper.IsSingleArgumentIndexer(expression.Body);
break;
// Property/field access is always legal
case ExpressionType.MemberAccess:
MemberExpression memberExpression = (MemberExpression)expression.Body;
propertyName = memberExpression.Member is PropertyInfo ? memberExpression.Member.Name : null;
containerType = memberExpression.Expression.Type;
legalExpression = true;
break;
// Parameter expression means "model => model", so we delegate to FromModel
case ExpressionType.Parameter:
return FromModel(viewData, metadataProvider);
}
if (!legalExpression) {
throw new InvalidOperationException(SR.GetString(SR.TemplateHelpers_TemplateLimitations));
}
TParameter container = viewData.Model;
Func<object> modelAccessor = () => {
try {
return CachedExpressionCompiler.Process(expression)(container);
}
catch (NullReferenceException) {
return null;
}
};
return GetMetadataFromProvider(modelAccessor, typeof(TValue), propertyName, containerType, metadataProvider);
}
private static ModelMetadata FromModel(ViewDataDictionary viewData, ModelMetadataProvider metadataProvider) {
return viewData.ModelMetadata ?? GetMetadataFromProvider(null, typeof(string), null, null, metadataProvider);
}
public static ModelMetadata FromStringExpression(string expression, ViewDataDictionary viewData) {
return FromStringExpression(expression, viewData, metadataProvider: null);
}
internal static ModelMetadata FromStringExpression(string expression, ViewDataDictionary viewData, ModelMetadataProvider metadataProvider) {
if (expression == null) {
throw new ArgumentNullException("expression");
}
if (viewData == null) {
throw new ArgumentNullException("viewData");
}
if (expression.Length == 0) { // Empty string really means "model metadata for the current model"
return FromModel(viewData, metadataProvider);
}
ViewDataInfo vdi = viewData.GetViewDataInfo(expression);
Type containerType = null;
Type modelType = null;
Func<object> modelAccessor = null;
string propertyName = null;
if (vdi != null) {
if (vdi.Container != null) {
containerType = vdi.Container.GetType();
}
modelAccessor = () => vdi.Value;
if (vdi.PropertyDescriptor != null) {
propertyName = vdi.PropertyDescriptor.Name;
modelType = vdi.PropertyDescriptor.PropertyType;
}
else if (vdi.Value != null) { // We only need to delay accessing properties (for LINQ to SQL)
modelType = vdi.Value.GetType();
}
}
// Try getting a property from ModelMetadata if we couldn't find an answer in ViewData
else if (viewData.ModelMetadata != null) {
ModelMetadata propertyMetadata = viewData.ModelMetadata.Properties.Where(p => p.PropertyName == expression).FirstOrDefault();
if (propertyMetadata != null) {
return propertyMetadata;
}
}
return GetMetadataFromProvider(modelAccessor, modelType ?? typeof(string), propertyName, containerType, metadataProvider);
}
#endif
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "The method is a delegating helper to choose among multiple property values")]
public string GetDisplayName() {
return DisplayName ?? PropertyName ?? ModelType.Name;
}
private static ModelMetadata GetMetadataFromProvider(Func<object> modelAccessor, Type modelType, string propertyName, Type containerType, ModelMetadataProvider metadataProvider) {
metadataProvider = metadataProvider ?? ModelMetadataProviders.Current;
if (containerType != null && !String.IsNullOrEmpty(propertyName)) {
return metadataProvider.GetMetadataForProperty(modelAccessor, containerType, propertyName);
}
return metadataProvider.GetMetadataForType(modelAccessor, modelType);
}
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "This method is used to resolve the simple display text when it was not explicitly set through other means.")]
protected virtual string GetSimpleDisplayText() {
if (Model == null) {
return NullDisplayText;
}
string toStringResult = Convert.ToString(Model, CultureInfo.CurrentCulture);
if (toStringResult == null) {
return String.Empty;
}
if (!toStringResult.Equals(Model.GetType().FullName, StringComparison.Ordinal)) {
return toStringResult;
}
ModelMetadata firstProperty = Properties.FirstOrDefault();
if (firstProperty == null) {
return String.Empty;
}
if (firstProperty.Model == null) {
return firstProperty.NullDisplayText;
}
return Convert.ToString(firstProperty.Model, CultureInfo.CurrentCulture);
}
public virtual IEnumerable<ModelValidator> GetValidators(ModelBindingExecutionContext context) {
return ModelValidatorProviders.Providers.GetValidators(this, context);
}
}
}
|