// 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.Threading.Tasks; using Microsoft.AspNet.Mvc.Formatters.Json.Logging; using Microsoft.AspNet.Mvc.Internal; using Microsoft.AspNet.Mvc.ModelBinding; using Microsoft.Extensions.Logging; using Newtonsoft.Json; namespace Microsoft.AspNet.Mvc.Formatters { public class JsonInputFormatter : InputFormatter { private JsonSerializerSettings _serializerSettings; private ILogger _logger; public JsonInputFormatter(ILogger logger) : this(logger, SerializerSettingsProvider.CreateSerializerSettings()) { } public JsonInputFormatter(ILogger logger, JsonSerializerSettings serializerSettings) { if (serializerSettings == null) { throw new ArgumentNullException(nameof(serializerSettings)); } if (logger == null) { throw new ArgumentNullException(nameof(logger)); } _logger = logger; _serializerSettings = serializerSettings; SupportedEncodings.Add(UTF8EncodingWithoutBOM); SupportedEncodings.Add(UTF16EncodingLittleEndian); SupportedMediaTypes.Add(MediaTypeHeaderValues.ApplicationJson); SupportedMediaTypes.Add(MediaTypeHeaderValues.TextJson); } /// /// Gets or sets the used to configure the . /// public JsonSerializerSettings SerializerSettings { get { return _serializerSettings; } set { if (value == null) { throw new ArgumentNullException(nameof(value)); } _serializerSettings = value; } } /// public override Task ReadRequestBodyAsync(InputFormatterContext context) { if (context == null) { throw new ArgumentNullException(nameof(context)); } // Get the character encoding for the content. var effectiveEncoding = SelectCharacterEncoding(context); if (effectiveEncoding == null) { return InputFormatterResult.FailureAsync(); } var request = context.HttpContext.Request; using (var streamReader = context.ReaderFactory(request.Body, effectiveEncoding)) { using (var jsonReader = new JsonTextReader(streamReader)) { 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 in case CreateJsonSerializer() reuses a serializer jsonSerializer.Error -= errorHandler; } if (successful) { return InputFormatterResult.SuccessAsync(model); } return InputFormatterResult.FailureAsync(); } } } /// /// Called during deserialization to get the . /// /// The used during serialization and deserialization. protected virtual JsonSerializer CreateJsonSerializer() { return JsonSerializer.Create(SerializerSettings); } 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; } } }