2021-03-29 14:54:12 +08:00
#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.Globalization ;
using LC.Newtonsoft.Json.Utilities ;
namespace LC.Newtonsoft.Json.Converters
{
/// <summary>
/// Converts a <see cref="DateTime"/> to and from the ISO 8601 date format (e.g. <c>"2008-04-12T12:53Z"</c>).
/// </summary>
public class IsoDateTimeConverter : DateTimeConverterBase
{
private const string DefaultDateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK" ;
private DateTimeStyles _dateTimeStyles = DateTimeStyles . RoundtripKind ;
2021-03-30 10:54:25 +08:00
private string _dateTimeFormat ;
private CultureInfo _culture ;
2021-03-29 14:54:12 +08:00
/// <summary>
/// Gets or sets the date time styles used when converting a date to and from JSON.
/// </summary>
/// <value>The date time styles used when converting a date to and from JSON.</value>
public DateTimeStyles DateTimeStyles
{
get = > _dateTimeStyles ;
set = > _dateTimeStyles = value ;
}
/// <summary>
/// Gets or sets the date time format used when converting a date to and from JSON.
/// </summary>
/// <value>The date time format used when converting a date to and from JSON.</value>
2021-03-30 10:54:25 +08:00
public string DateTimeFormat
2021-03-29 14:54:12 +08:00
{
get = > _dateTimeFormat ? ? string . Empty ;
2021-03-30 10:54:25 +08:00
set = > _dateTimeFormat = ( string . IsNullOrEmpty ( value ) ) ? null : value ;
2021-03-29 14:54:12 +08:00
}
/// <summary>
/// Gets or sets the culture used when converting a date to and from JSON.
/// </summary>
/// <value>The culture used when converting a date to and from JSON.</value>
public CultureInfo Culture
{
get = > _culture ? ? CultureInfo . CurrentCulture ;
set = > _culture = value ;
}
/// <summary>
/// Writes the JSON representation of the object.
/// </summary>
/// <param name="writer">The <see cref="JsonWriter"/> to write to.</param>
/// <param name="value">The value.</param>
/// <param name="serializer">The calling serializer.</param>
2021-03-30 10:54:25 +08:00
public override void WriteJson ( JsonWriter writer , object value , JsonSerializer serializer )
2021-03-29 14:54:12 +08:00
{
string text ;
if ( value is DateTime dateTime )
{
if ( ( _dateTimeStyles & DateTimeStyles . AdjustToUniversal ) = = DateTimeStyles . AdjustToUniversal
| | ( _dateTimeStyles & DateTimeStyles . AssumeUniversal ) = = DateTimeStyles . AssumeUniversal )
{
dateTime = dateTime . ToUniversalTime ( ) ;
}
text = dateTime . ToString ( _dateTimeFormat ? ? DefaultDateTimeFormat , Culture ) ;
}
#if HAVE_DATE_TIME_OFFSET
else if ( value is DateTimeOffset dateTimeOffset )
{
if ( ( _dateTimeStyles & DateTimeStyles . AdjustToUniversal ) = = DateTimeStyles . AdjustToUniversal
| | ( _dateTimeStyles & DateTimeStyles . AssumeUniversal ) = = DateTimeStyles . AssumeUniversal )
{
dateTimeOffset = dateTimeOffset . ToUniversalTime ( ) ;
}
text = dateTimeOffset . ToString ( _dateTimeFormat ? ? DefaultDateTimeFormat , Culture ) ;
}
# endif
else
{
2021-03-30 10:54:25 +08:00
throw new JsonSerializationException ( "Unexpected value when converting date. Expected DateTime or DateTimeOffset, got {0}." . FormatWith ( CultureInfo . InvariantCulture , ReflectionUtils . GetObjectType ( value ) ) ) ;
2021-03-29 14:54:12 +08:00
}
writer . WriteValue ( text ) ;
}
/// <summary>
/// Reads the JSON representation of the object.
/// </summary>
/// <param name="reader">The <see cref="JsonReader"/> to read from.</param>
/// <param name="objectType">Type of the object.</param>
/// <param name="existingValue">The existing value of object being read.</param>
/// <param name="serializer">The calling serializer.</param>
/// <returns>The object value.</returns>
2021-03-30 10:54:25 +08:00
public override object ReadJson ( JsonReader reader , Type objectType , object existingValue , JsonSerializer serializer )
2021-03-29 14:54:12 +08:00
{
bool nullable = ReflectionUtils . IsNullableType ( objectType ) ;
if ( reader . TokenType = = JsonToken . Null )
{
if ( ! nullable )
{
throw JsonSerializationException . Create ( reader , "Cannot convert null value to {0}." . FormatWith ( CultureInfo . InvariantCulture , objectType ) ) ;
}
return null ;
}
#if HAVE_DATE_TIME_OFFSET
Type t = ( nullable )
? Nullable . GetUnderlyingType ( objectType )
: objectType ;
# endif
if ( reader . TokenType = = JsonToken . Date )
{
#if HAVE_DATE_TIME_OFFSET
if ( t = = typeof ( DateTimeOffset ) )
{
2021-03-30 10:54:25 +08:00
return ( reader . Value is DateTimeOffset ) ? reader . Value : new DateTimeOffset ( ( DateTime ) reader . Value ) ;
2021-03-29 14:54:12 +08:00
}
// converter is expected to return a DateTime
if ( reader . Value is DateTimeOffset offset )
{
return offset . DateTime ;
}
# endif
return reader . Value ;
}
if ( reader . TokenType ! = JsonToken . String )
{
throw JsonSerializationException . Create ( reader , "Unexpected token parsing date. Expected String, got {0}." . FormatWith ( CultureInfo . InvariantCulture , reader . TokenType ) ) ;
}
2021-03-30 10:54:25 +08:00
string dateText = reader . Value . ToString ( ) ;
2021-03-29 14:54:12 +08:00
2021-03-30 10:54:25 +08:00
if ( string . IsNullOrEmpty ( dateText ) & & nullable )
2021-03-29 14:54:12 +08:00
{
return null ;
}
#if HAVE_DATE_TIME_OFFSET
if ( t = = typeof ( DateTimeOffset ) )
{
2021-03-30 10:54:25 +08:00
if ( ! string . IsNullOrEmpty ( _dateTimeFormat ) )
2021-03-29 14:54:12 +08:00
{
return DateTimeOffset . ParseExact ( dateText , _dateTimeFormat , Culture , _dateTimeStyles ) ;
}
else
{
return DateTimeOffset . Parse ( dateText , Culture , _dateTimeStyles ) ;
}
}
# endif
2021-03-30 10:54:25 +08:00
if ( ! string . IsNullOrEmpty ( _dateTimeFormat ) )
2021-03-29 14:54:12 +08:00
{
return DateTime . ParseExact ( dateText , _dateTimeFormat , Culture , _dateTimeStyles ) ;
}
else
{
return DateTime . Parse ( dateText , Culture , _dateTimeStyles ) ;
}
}
}
}