/
ValidationContext.cs
232 lines (203 loc) · 10.2 KB
/
ValidationContext.cs
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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
namespace System.ComponentModel.DataAnnotations
{
/// <summary>
/// Describes the context in which a validation is being performed.
/// </summary>
/// <remarks>
/// This class contains information describing the instance on which
/// validation is being performed.
/// <para>
/// It supports <see cref="IServiceProvider" /> so that custom validation
/// code can acquire additional services to help it perform its validation.
/// </para>
/// <para>
/// An <see cref="Items" /> property bag is available for additional contextual
/// information about the validation. Values stored in <see cref="Items" />
/// will be available to validation methods that use this <see cref="ValidationContext" />
/// </para>
/// </remarks>
public sealed class ValidationContext
// WinStore impl no longer inherits from IServiceProvider but still has GetService()???
// Also we use this ability in Validator.CreateValidationContext()??
: IServiceProvider
{
internal const string InstanceTypeNotStaticallyDiscovered = "The Type of instance cannot be statically discovered.";
#region Member Fields
private readonly Dictionary<object, object?> _items;
private string? _displayName;
private Func<Type, object?>? _serviceProvider;
#endregion
#region Constructors
/// <summary>
/// Construct a <see cref="ValidationContext" /> for a given object instance being validated.
/// </summary>
/// <param name="instance">The object instance being validated. It cannot be <c>null</c>.</param>
/// <exception cref="ArgumentNullException">When <paramref name="instance" /> is <c>null</c></exception>
[RequiresUnreferencedCode(InstanceTypeNotStaticallyDiscovered)]
public ValidationContext(object instance)
: this(instance, null, null)
{
}
/// <summary>
/// Construct a <see cref="ValidationContext" /> for a given object instance and an optional
/// property bag of <paramref name="items" />.
/// </summary>
/// <param name="instance">The object instance being validated. It cannot be null.</param>
/// <param name="items">
/// Optional set of key/value pairs to make available to consumers via <see cref="Items" />.
/// If null, an empty dictionary will be created. If not null, the set of key/value pairs will be copied into a
/// new dictionary, preventing consumers from modifying the original dictionary.
/// </param>
/// <exception cref="ArgumentNullException">When <paramref name="instance" /> is <c>null</c></exception>
[RequiresUnreferencedCode(InstanceTypeNotStaticallyDiscovered)]
public ValidationContext(object instance, IDictionary<object, object?>? items)
: this(instance, null, items)
{
}
/// <summary>
/// Construct a <see cref="ValidationContext" /> for a given object instance, an optional
/// <paramref name="serviceProvider" />, and an optional
/// property bag of <paramref name="items" />.
/// </summary>
/// <param name="instance">The object instance being validated. It cannot be null.</param>
/// <param name="serviceProvider">
/// Optional <see cref="IServiceProvider" /> to use when <see cref="GetService" /> is called.
/// If it is null, <see cref="GetService" /> will always return null.
/// </param>
/// <param name="items">
/// Optional set of key/value pairs to make available to consumers via <see cref="Items" />.
/// If null, an empty dictionary will be created. If not null, the set of key/value pairs will be copied into a
/// new dictionary, preventing consumers from modifying the original dictionary.
/// </param>
/// <exception cref="ArgumentNullException">When <paramref name="instance" /> is <c>null</c></exception>
[RequiresUnreferencedCode(InstanceTypeNotStaticallyDiscovered)]
public ValidationContext(object instance, IServiceProvider? serviceProvider, IDictionary<object, object?>? items)
{
ArgumentNullException.ThrowIfNull(instance);
if (serviceProvider != null)
{
IServiceProvider localServiceProvider = serviceProvider;
InitializeServiceProvider(localServiceProvider.GetService);
}
_items = items != null ? new Dictionary<object, object?>(items) : new Dictionary<object, object?>();
ObjectInstance = instance;
}
#endregion
#region Properties
/// <summary>
/// Gets the object instance being validated. While it will not be null, the state of the instance is indeterminate
/// as it might only be partially initialized during validation.
/// <para>Consume this instance with caution!</para>
/// </summary>
/// <remarks>
/// During validation, especially property-level validation, the object instance might be in an indeterminate state.
/// For example, the property being validated, as well as other properties on the instance might not have been
/// updated to their new values.
/// </remarks>
public object ObjectInstance { get; }
/// <summary>
/// Gets the type of the object being validated. It will not be null.
/// </summary>
public Type ObjectType => ObjectInstance.GetType();
/// <summary>
/// Gets or sets the user-visible name of the type or property being validated.
/// </summary>
/// <value>
/// If this name was not explicitly set, this property will consult an associated <see cref="DisplayAttribute" />
/// to see if can use that instead. Lacking that, it returns <see cref="MemberName" />. The
/// <see cref="ObjectInstance" />
/// type name will be used if MemberName has not been set.
/// </value>
public string DisplayName
{
get
{
if (string.IsNullOrEmpty(_displayName))
{
_displayName = GetDisplayName();
if (string.IsNullOrEmpty(_displayName))
{
_displayName = ObjectType.Name;
}
}
return _displayName;
}
set
{
if (string.IsNullOrEmpty(value))
{
throw new ArgumentNullException(nameof(value));
}
_displayName = value;
}
}
/// <summary>
/// Gets or sets the name of the type or property being validated.
/// </summary>
/// <value>
/// This name reflects the API name of the member being validated, not a localized name. It should be set
/// only for property or parameter contexts.
/// </value>
public string? MemberName { get; set; }
/// <summary>
/// Gets the dictionary of key/value pairs associated with this context.
/// </summary>
/// <value>
/// This property will never be null, but the dictionary may be empty. Changes made
/// to items in this dictionary will never affect the original dictionary specified in the constructor.
/// </value>
public IDictionary<object, object?> Items => _items;
#endregion
#region Methods
/// <summary>
/// Looks up the display name using the DisplayAttribute attached to the respective type or property.
/// </summary>
/// <returns>A display-friendly name of the member represented by the <see cref="MemberName" />.</returns>
[UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode", Justification = "The ctors are marked with RequiresUnreferencedCode.")]
private string? GetDisplayName()
{
string? displayName = null;
ValidationAttributeStore store = ValidationAttributeStore.Instance;
DisplayAttribute? displayAttribute = null;
if (string.IsNullOrEmpty(MemberName))
{
displayAttribute = store.GetTypeDisplayAttribute(this);
}
else if (store.IsPropertyContext(this))
{
displayAttribute = store.GetPropertyDisplayAttribute(this);
}
if (displayAttribute != null)
{
displayName = displayAttribute.GetName();
}
return displayName ?? MemberName;
}
/// <summary>
/// Initializes the <see cref="ValidationContext" /> with a service provider that can return
/// service instances by <see cref="Type" /> when <see cref="GetService" /> is called.
/// </summary>
/// <param name="serviceProvider">
/// A <see cref="Func{T, TResult}" /> that can return service instances given the
/// desired <see cref="Type" /> when <see cref="GetService" /> is called.
/// If it is <c>null</c>, <see cref="GetService" /> will always return <c>null</c>.
/// </param>
public void InitializeServiceProvider(Func<Type, object?> serviceProvider)
{
_serviceProvider = serviceProvider;
}
#endregion
#region IServiceProvider Members
/// <summary>
/// See <see cref="IServiceProvider.GetService(Type)" />.
/// </summary>
/// <param name="serviceType">The type of the service needed.</param>
/// <returns>An instance of that service or null if it is not available.</returns>
public object? GetService(Type serviceType) => _serviceProvider?.Invoke(serviceType);
#endregion
}
}