From 8bb337debb338179a64cfdd366d764ce57492aef Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Thu, 22 Feb 2018 16:16:22 +1300 Subject: [PATCH] -Fixed serializing FileInfo/DirectoryInfo on .NET Core with JsonConverter --- Src/Newtonsoft.Json.Tests/Issues/Issue1619.cs | 86 +++++++++++++++++++ .../Serialization/DefaultContractResolver.cs | 19 ++-- 2 files changed, 98 insertions(+), 7 deletions(-) create mode 100644 Src/Newtonsoft.Json.Tests/Issues/Issue1619.cs diff --git a/Src/Newtonsoft.Json.Tests/Issues/Issue1619.cs b/Src/Newtonsoft.Json.Tests/Issues/Issue1619.cs new file mode 100644 index 00000000..25041685 --- /dev/null +++ b/Src/Newtonsoft.Json.Tests/Issues/Issue1619.cs @@ -0,0 +1,86 @@ +#region License +// Copyright (c) 2007 James Newton-King +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +#endregion + +using System; +using System.IO; +#if DNXCORE50 +using Xunit; +using Test = Xunit.FactAttribute; +using Assert = Newtonsoft.Json.Tests.XUnitAssert; +#else +using NUnit.Framework; +#endif + +namespace Newtonsoft.Json.Tests.Issues +{ + [TestFixture] + public class Issue1619 : TestFixtureBase + { + [Test] + public void Test() + { + Foo value = new Foo + { + Bar = new DirectoryInfo(@"c:\temp") + }; + + string json = JsonConvert.SerializeObject(value, new DirectoryInfoJsonConverter()); + Assert.AreEqual(@"{""Bar"":""c:\\temp""}", json); + } + + public class Foo + { + public DirectoryInfo Bar { get; set; } + } + + public class DirectoryInfoJsonConverter : JsonConverter + { + public override bool CanConvert(Type objectType) + { + return objectType == typeof(DirectoryInfo); + } + + public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) + { + if (reader.Value is string s) + { + return new DirectoryInfo(s); + } + + throw new ArgumentOutOfRangeException(nameof(reader)); + } + + public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) + { + if (!(value is DirectoryInfo directoryInfo)) + { + throw new ArgumentOutOfRangeException(nameof(value)); + } + + writer.WriteValue(directoryInfo.FullName); + } + } + } +} \ No newline at end of file diff --git a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs index 05e2bac8..0c1f16ea 100644 --- a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs @@ -313,13 +313,6 @@ namespace Newtonsoft.Json.Serialization /// A for the given type. protected virtual JsonObjectContract CreateObjectContract(Type objectType) { - // serializing DirectoryInfo without ISerializable will stackoverflow - // https://github.com/JamesNK/Newtonsoft.Json/issues/1541 - if (Array.IndexOf(BlacklistedTypeNames, objectType.FullName) != -1) - { - throw new JsonSerializationException("Unable to serialize instance of '{0}'.".FormatWith(CultureInfo.InvariantCulture, objectType)); - } - JsonObjectContract contract = new JsonObjectContract(objectType); InitializeContract(contract); @@ -404,9 +397,21 @@ namespace Newtonsoft.Json.Serialization SetExtensionDataDelegates(contract, extensionDataMember); } + // serializing DirectoryInfo without ISerializable will stackoverflow + // https://github.com/JamesNK/Newtonsoft.Json/issues/1541 + if (Array.IndexOf(BlacklistedTypeNames, objectType.FullName) != -1) + { + contract.OnSerializingCallbacks.Add(ThrowUnableToSerializeError); + } + return contract; } + private static void ThrowUnableToSerializeError(object o, StreamingContext context) + { + throw new JsonSerializationException("Unable to serialize instance of '{0}'.".FormatWith(CultureInfo.InvariantCulture, o.GetType())); + } + private MemberInfo GetExtensionDataMemberForType(Type type) { IEnumerable members = GetClassHierarchyForType(type).SelectMany(baseType =>