// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System; using System.Buffers; using System.Text; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc.Formatters.Json.Internal; using Microsoft.AspNetCore.Mvc.ModelBinding; using Microsoft.Extensions.Logging; using Microsoft.Extensions.ObjectPool; using Newtonsoft.Json; namespace Microsoft.AspNetCore.Mvc.Formatters { /// /// An for JSON content. /// public class JsonInputFormatter : TextInputFormatter { private readonly IArrayPool _charPool; private readonly ILogger _logger; private readonly ObjectPoolProvider _objectPoolProvider; private ObjectPool _jsonSerializerPool; private JsonSerializerSettings _serializerSettings; /// /// Initializes a new instance of . /// /// The . public JsonInputFormatter(ILogger logger) : this(logger, SerializerSettingsProvider.CreateSerializerSettings()) { } /// /// Initializes a new instance of . /// /// The . /// The . public JsonInputFormatter(ILogger logger, JsonSerializerSettings serializerSettings) : this( logger, serializerSettings, ArrayPool.Shared, new DefaultObjectPoolProvider()) { } /// /// Initializes a new instance of . /// /// The . /// The . /// The . /// The . public JsonInputFormatter( ILogger logger, JsonSerializerSettings serializerSettings, ArrayPool charPool, ObjectPoolProvider objectPoolProvider) { if (logger == null) { throw new ArgumentNullException(nameof(logger)); } if (serializerSettings == null) { throw new ArgumentNullException(nameof(serializerSettings)); } if (charPool == null) { throw new ArgumentNullException(nameof(charPool)); } if (objectPoolProvider == null) { throw new ArgumentNullException(nameof(objectPoolProvider)); } _logger = logger; _serializerSettings = serializerSettings; _charPool = new JsonArrayPool(charPool); _objectPoolProvider = objectPoolProvider; SupportedEncodings.Add(UTF8EncodingWithoutBOM); SupportedEncodings.Add(UTF16EncodingLittleEndian); SupportedMediaTypes.Add(MediaTypeHeaderValues.ApplicationJson); SupportedMediaTypes.Add(MediaTypeHeaderValues.TextJson); } /// /// Gets or sets the used to configure the . /// /// /// Any modifications to the object after this /// has been used will have no effect. /// public JsonSerializerSettings SerializerSettings { get { return _serializerSettings; } set { if (value == null) { throw new ArgumentNullException(nameof(value)); } _serializerSettings = value; } } /// public override Task ReadRequestBodyAsync( InputFormatterContext context, Encoding encoding) { if (context == null) { throw new ArgumentNullException(nameof(context)); } if (encoding == null) { throw new ArgumentNullException(nameof(encoding)); } var request = context.HttpContext.Request; using (var streamReader = context.ReaderFactory(request.Body, encoding)) { using (var jsonReader = new JsonTextReader(streamReader)) { jsonReader.ArrayPool = _charPool; jsonReader.CloseInput = false; var successful = true; EventHandler errorHandler = (sender, eventArgs) => { successful = false; var exception = eventArgs.ErrorContext.Error; // Handle path combinations such as "" + "Property", "Parent" + "Property", or "Parent" + "[12]". var key = eventArgs.ErrorContext.Path; if (!string.IsNullOrEmpty(context.ModelName)) { if (string.IsNullOrEmpty(eventArgs.ErrorContext.Path)) { key = context.ModelName; } else if (eventArgs.ErrorContext.Path[0] == '[') { key = context.ModelName + eventArgs.ErrorContext.Path; } else { key = context.ModelName + "." + eventArgs.ErrorContext.Path; } } var metadata = GetPathMetadata(context.Metadata, eventArgs.ErrorContext.Path); context.ModelState.TryAddModelError(key, eventArgs.ErrorContext.Error, metadata); _logger.JsonInputException(eventArgs.ErrorContext.Error); // Error must always be marked as handled // Failure to do so can cause the exception to be rethrown at every recursive level and // overflow the stack for x64 CLR processes eventArgs.ErrorContext.Handled = true; }; var type = context.ModelType; var jsonSerializer = CreateJsonSerializer(); jsonSerializer.Error += errorHandler; object model; try { model = jsonSerializer.Deserialize(jsonReader, type); } finally { // Clean up the error handler since CreateJsonSerializer() pools instances. jsonSerializer.Error -= errorHandler; ReleaseJsonSerializer(jsonSerializer); } if (successful) { return InputFormatterResult.SuccessAsync(model); } return InputFormatterResult.FailureAsync(); } } } /// /// Called during deserialization to get the . /// /// The used during deserialization. /// /// This method works in tandem with to /// manage the lifetimes of instances. /// protected virtual JsonSerializer CreateJsonSerializer() { if (_jsonSerializerPool == null) { _jsonSerializerPool = _objectPoolProvider.Create(new JsonSerializerObjectPolicy(SerializerSettings)); } return _jsonSerializerPool.Get(); } /// /// Releases the instance. /// /// The to release. /// /// This method works in tandem with to /// manage the lifetimes of instances. /// protected virtual void ReleaseJsonSerializer(JsonSerializer serializer) => _jsonSerializerPool.Return(serializer); private ModelMetadata GetPathMetadata(ModelMetadata metadata, string path) { var index = 0; while (index >= 0 && index < path.Length) { if (path[index] == '[') { // At start of "[0]". if (metadata.ElementMetadata == null) { // Odd case but don't throw just because ErrorContext had an odd-looking path. break; } metadata = metadata.ElementMetadata; index = path.IndexOf(']', index); } else if (path[index] == '.' || path[index] == ']') { // Skip '.' in "prefix.property" or "[0].property" or ']' in "[0]". index++; } else { // At start of "property", "property." or "property[0]". var endIndex = path.IndexOfAny(new[] { '.', '[' }, index); if (endIndex == -1) { endIndex = path.Length; } var propertyName = path.Substring(index, endIndex - index); if (metadata.Properties[propertyName] == null) { // Odd case but don't throw just because ErrorContext had an odd-looking path. break; } metadata = metadata.Properties[propertyName]; index = endIndex; } } return metadata; } } }