Merge pull request #469 from rsafier/master

Add JsScope.PreserveUtc. When true overrides standard behavior of con…

Author: mythz

src/ServiceStack.Text/Common/DateTimeSerializer.cs

@@ -16,6 +16,7 @@
 using System.Text;
 using ServiceStack.Text.Json;
 using ServiceStack.Text.Support;
+using System.Text.RegularExpressions;
 
 namespace ServiceStack.Text.Common
 {
@@ -24,11 +25,14 @@ public static class DateTimeSerializer
         public const string CondensedDateTimeFormat = "yyyyMMdd";                             //8
         public const string ShortDateTimeFormat = "yyyy-MM-dd";                               //11
         public const string DefaultDateTimeFormat = "dd/MM/yyyy HH:mm:ss";                    //20
+        public const string DefaultDateTimeFormatWithFraction = "dd/MM/yyyy HH:mm:ss.fff";    //24
         public const string XsdDateTimeFormat = "yyyy-MM-ddTHH:mm:ss.fffffffZ";               //29
         public const string XsdDateTimeFormat3F = "yyyy-MM-ddTHH:mm:ss.fffZ";                 //25
         public const string XsdDateTimeFormatSeconds = "yyyy-MM-ddTHH:mm:ssZ";                //21
         public const string DateTimeFormatSecondsUtcOffset = "yyyy-MM-ddTHH:mm:sszzz";        //22
+        public const string DateTimeFormatSecondsNoOffset = "yyyy-MM-ddTHH:mm:ss";        
         public const string DateTimeFormatTicksUtcOffset = "yyyy-MM-ddTHH:mm:ss.fffffffzzz";  //30
+        public const string DateTimeFormatTicksNoUtcOffset = "yyyy-MM-ddTHH:mm:ss.fffffff";  
 
         public const string EscapedWcfJsonPrefix = "\\/Date(";
         public const string EscapedWcfJsonSuffix = ")\\/";
@@ -41,20 +45,25 @@ public static class DateTimeSerializer
         private static readonly int XsdTimeSeparatorIndex = XsdDateTimeFormat.IndexOf(XsdTimeSeparator);
         private const string XsdUtcSuffix = "Z";
         private static readonly char[] DateTimeSeperators = new[] { '-', '/' };
-
+        private static readonly Regex UtcOffsetInfoRegex = new Regex("([+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])", RegexOptions.Compiled);
         public static Func<string, Exception, DateTime> OnParseErrorFn { get; set; }
 
         /// <summary>
-        /// If AlwaysUseUtc is set to true then convert all DateTime to UTC.
+        /// If AlwaysUseUtc is set to true then convert all DateTime to UTC. If PreserveUtc is set to true then UTC dates will not convert to local
         /// </summary>
         /// <param name="dateTime"></param>
         /// <returns></returns>
         public static DateTime Prepare(this DateTime dateTime, bool parsedAsUtc = false)
         {
+            if (JsConfig.SkipDateTimeConversion)
+            {
+                return dateTime;
+            }
             if (JsConfig.AlwaysUseUtc)
             {
                 return dateTime.Kind != DateTimeKind.Utc ? dateTime.ToStableUniversalTime() : dateTime;
             }
+            
             return parsedAsUtc ? dateTime.ToLocalTime() : dateTime;
         }
 
@@ -91,6 +100,16 @@ public static DateTime ParseShortestXsdDateTime(string dateTimeStr)
                     return unspecifiedDate.Prepare();
                 }
 
+                if (dateTimeStr.Length == DefaultDateTimeFormatWithFraction.Length)
+                {
+                    var unspecifiedDate = JsConfig.AssumeUtc    
+                        ? DateTime.Parse(dateTimeStr, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal)
+                        : DateTime.Parse(dateTimeStr, CultureInfo.InvariantCulture);
+
+                    return unspecifiedDate.Prepare();
+                }
+                DateTimeKind kind = DateTimeKind.Unspecified;
+
                 switch (JsConfig.DateHandler)
                 {
                     case DateHandler.UnixTime:
@@ -103,6 +122,12 @@ public static DateTime ParseShortestXsdDateTime(string dateTimeStr)
                         if (long.TryParse(dateTimeStr, out unixTimeMs))
                             return unixTimeMs.FromUnixTimeMs();
                         break;
+                    case DateHandler.ISO8601:
+                        if (JsConfig.SkipDateTimeConversion)
+                        {
+                            dateTimeStr = RemoveUtcOffsets(dateTimeStr, out kind); 
+                        }
+                        break;
                 }
 
                 dateTimeStr = RepairXsdTimeSeparator(dateTimeStr);
@@ -139,8 +164,21 @@ public static DateTime ParseShortestXsdDateTime(string dateTimeStr)
 
                 try
                 {
-                    var assumeKind = JsConfig.AssumeUtc ? DateTimeStyles.AssumeUniversal : DateTimeStyles.AssumeLocal;
-                    var dateTime = DateTime.Parse(dateTimeStr, CultureInfo.InvariantCulture, assumeKind);
+                    DateTime dateTime;
+                    if (JsConfig.SkipDateTimeConversion)
+                    {
+                        dateTime = DateTime.Parse(dateTimeStr, null, 
+                            kind == DateTimeKind.Unspecified ?
+                            DateTimeStyles.None :
+                            kind == DateTimeKind.Local ?
+                            DateTimeStyles.AssumeLocal :
+                            DateTimeStyles.AssumeUniversal);
+                    }
+                    else
+                    {
+                        var assumeKind = JsConfig.AssumeUtc ? DateTimeStyles.AssumeUniversal : DateTimeStyles.AssumeLocal;
+                        dateTime = DateTime.Parse(dateTimeStr, CultureInfo.InvariantCulture, assumeKind);
+                    }
                     return dateTime.Prepare();
                 }
                 catch (FormatException)
@@ -161,6 +199,18 @@ public static DateTime ParseShortestXsdDateTime(string dateTimeStr)
             }
         }
 
+        private static string RemoveUtcOffsets(string dateTimeStr, out DateTimeKind kind)
+        { 
+            var startOfTz = UtcOffsetInfoRegex.Match(dateTimeStr);
+            if (startOfTz.Index > 0) 
+            {
+                kind =  DateTimeKind.Local;
+                return dateTimeStr.Substring(0, startOfTz.Index);
+            }
+            kind =  dateTimeStr.Contains("Z") ? DateTimeKind.Utc : DateTimeKind.Unspecified;
+            return dateTimeStr;
+        }
+
         /// <summary>
         /// Repairs an out-of-spec XML date/time string which incorrectly uses a space instead of a 'T' to separate the date from the time.
         /// These string are occasionally generated by SQLite and can cause errors in OrmLite when reading these columns from the DB.
@@ -180,7 +230,7 @@ private static string RepairXsdTimeSeparator(string dateTimeStr)
 
         public static DateTime? ParseManual(string dateTimeStr)
         {
-            var dateKind = JsConfig.AssumeUtc || JsConfig.AlwaysUseUtc
+            var dateKind = JsConfig.AssumeUtc || JsConfig.AlwaysUseUtc 
                 ? DateTimeKind.Utc
                 : DateTimeKind.Local;
 
@@ -201,6 +251,7 @@ private static string RepairXsdTimeSeparator(string dateTimeStr)
             if (dateTimeStr.EndsWith(XsdUtcSuffix))
             {
                 dateTimeStr = dateTimeStr.Substring(0, dateTimeStr.Length - 1);
+                dateKind = JsConfig.SkipDateTimeConversion ? DateTimeKind.Utc : dateKind;  
             }
 
             var parts = dateTimeStr.Split('T');
@@ -320,7 +371,7 @@ public static DateTimeOffset ParseDateTimeOffset(string dateTimeOffsetStr)
                 if (Env.IsMono)
                 {
                     // Without that Mono uses a Local timezone))
-                    dateTimeOffsetStr = dateTimeOffsetStr.Substring(0, dateTimeOffsetStr.Length - 1) + "+00:00";
+                    dateTimeOffsetStr = dateTimeOffsetStr.Substring(0, dateTimeOffsetStr.Length - 1) + "+00:00";                     
                 }
             }
 
@@ -364,7 +415,7 @@ public static TimeSpan ParseTimeSpan(string dateTimeStr)
         {
             return dateTimeStr.StartsWith("P", StringComparison.Ordinal) || dateTimeStr.StartsWith("-P", StringComparison.Ordinal)
                 ? ParseXsdTimeSpan(dateTimeStr)
-                : dateTimeStr.Contains(":")
+                : dateTimeStr.Contains(":") 
                 ? TimeSpan.Parse(dateTimeStr)
                 : ParseNSTimeInterval(dateTimeStr);
         }
@@ -399,11 +450,26 @@ public static string ToShortestXsdDateTimeString(DateTime dateTime)
             var timeOfDay = dateTime.TimeOfDay;
 
             var isStartOfDay = timeOfDay.Ticks == 0;
-            if (isStartOfDay)
+            if (isStartOfDay && !(JsConfig.SkipDateTimeConversion))
                 return dateTime.ToString(ShortDateTimeFormat);
 
-            var hasFractionalSecs = (timeOfDay.Milliseconds != 0)
-                || ((timeOfDay.Ticks % TimeSpan.TicksPerMillisecond) != 0);
+            var hasFractionalSecs = (timeOfDay.Milliseconds != 0) 
+                || ((timeOfDay.Ticks%TimeSpan.TicksPerMillisecond) != 0);
+            if (JsConfig.SkipDateTimeConversion)
+            {
+                if (!hasFractionalSecs)
+                    return dateTime.Kind == DateTimeKind.Local
+                        ? dateTime.ToString(DateTimeFormatSecondsUtcOffset)
+                        : dateTime.Kind == DateTimeKind.Unspecified
+                        ? dateTime.ToString(DateTimeFormatSecondsNoOffset)
+                        : dateTime.ToStableUniversalTime().ToString(XsdDateTimeFormatSeconds);
+
+                return dateTime.Kind == DateTimeKind.Local
+                    ? dateTime.ToString(DateTimeFormatTicksUtcOffset)
+                    : dateTime.Kind == DateTimeKind.Unspecified
+                    ? dateTime.ToString(DateTimeFormatTicksNoUtcOffset)
+                    : PclExport.Instance.ToXsdDateTimeString(dateTime);
+            }
             if (!hasFractionalSecs)
                 return dateTime.Kind != DateTimeKind.Utc
                     ? dateTime.ToString(DateTimeFormatSecondsUtcOffset)
@@ -528,7 +594,15 @@ public static void WriteWcfJsonDate(TextWriter writer, DateTime dateTime)
 
             if (JsConfig.DateHandler == DateHandler.ISO8601)
             {
+                if (!JsConfig.SkipDateTimeConversion)
+                {
                 writer.Write(dateTime.ToString("o", CultureInfo.InvariantCulture));
+                }
+                else
+                {
+                    var dt = dateTime.ToString("o", CultureInfo.InvariantCulture);
+                    writer.Write(dt);
+                }
                 return;
             }
 

src/ServiceStack.Text/JsConfig.cs

@@ -54,6 +54,7 @@ public static JsConfigScope With(
             Func<Type, string> typeWriter = null,
             Func<string, Type> typeFinder = null,
             bool? treatEnumAsInteger = null,
+            bool? skipDateTimeConversion = null,
             bool? alwaysUseUtc = null,
             bool? assumeUtc = null,
             bool? appendUtcOffset = null,
@@ -70,8 +71,8 @@ public static JsConfigScope With(
                 TryToParsePrimitiveTypeValues = tryToParsePrimitiveTypeValues ?? sTryToParsePrimitiveTypeValues,
                 TryToParseNumericType = tryToParseNumericType ?? sTryToParseNumericType,
 
-				ParsePrimitiveFloatingPointTypes = parsePrimitiveFloatingPointTypes ?? sParsePrimitiveFloatingPointTypes,
-				ParsePrimitiveIntegerTypes = parsePrimitiveIntegerTypes ?? sParsePrimitiveIntegerTypes,
+                ParsePrimitiveFloatingPointTypes = parsePrimitiveFloatingPointTypes ?? sParsePrimitiveFloatingPointTypes,
+                ParsePrimitiveIntegerTypes = parsePrimitiveIntegerTypes ?? sParsePrimitiveIntegerTypes,
 
                 ExcludeDefaultValues = excludeDefaultValues ?? sExcludeDefaultValues,
                 IncludeNullValues = includeNullValues ?? sIncludeNullValues,
@@ -90,6 +91,7 @@ public static JsConfigScope With(
                 TypeWriter = typeWriter ?? sTypeWriter,
                 TypeFinder = typeFinder ?? sTypeFinder,
                 TreatEnumAsInteger = treatEnumAsInteger ?? sTreatEnumAsInteger,
+                SkipDateTimeConversion = skipDateTimeConversion ?? sSkipDateTimeConversion,
                 AlwaysUseUtc = alwaysUseUtc ?? sAlwaysUseUtc,
                 AssumeUtc = assumeUtc ?? sAssumeUtc,
                 AppendUtcOffset = appendUtcOffset ?? sAppendUtcOffset,
@@ -511,6 +513,28 @@ public static bool AlwaysUseUtc
             }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating if the framework should skip automatic <see cref="DateTime"/> conversions.
+        /// Dates will be handled literally, any included timezone encoding will be lost and the date will be treaded as DateTimeKind.Local
+        /// Utc formatted input will result in DateTimeKind.Utc output. Any input without TZ data will be set DateTimeKind.Unspecified
+        /// This will take precedence over other flags like AlwaysUseUtc 
+        /// JsConfig.DateHandler = DateHandler.ISO8601 should be used when set true for consistent de/serialization.
+        /// </summary>
+        private static bool? sSkipDateTimeConversion;
+        public static bool SkipDateTimeConversion
+        {
+            // obeying the use of ThreadStatic, but allowing for setting JsConfig once as is the normal case
+            get
+            {
+                return (JsConfigScope.Current != null ? JsConfigScope.Current.SkipDateTimeConversion : null)
+                    ?? sSkipDateTimeConversion
+                    ?? false;
+            }
+            set
+            {
+                if (!sSkipDateTimeConversion.HasValue) sSkipDateTimeConversion = value;
+            }
+        }
         /// <summary>
         /// Gets or sets a value indicating if the framework should always assume <see cref="DateTime"/> is in UTC format if Kind is Unspecified. 
         /// </summary>

src/ServiceStack.Text/JsConfigScope.cs

@@ -71,6 +71,7 @@ public void Dispose()
         public bool? EmitCamelCaseNames { get; set; }
         public bool? EmitLowercaseUnderscoreNames { get; set; }
         public bool? ThrowOnDeserializationError { get; set; }
+        public bool? SkipDateTimeConversion { get; set; }
         public bool? AlwaysUseUtc { get; set; }
         public bool? AssumeUtc { get; set; }
         public bool? AppendUtcOffset { get; set; }