Changeset 74148 in vbox for trunk/src/VBox/Runtime

Timestamp:

Sep 7, 2018 6:50:54 PM (6 years ago)

Author:

vboxsync

Message:

IPRT/time: Added RTTimeFromRfc2822 and RTTimeToStringEx (both untested). Fixed faction parsing in RTTimeFromString. bugref:9167

File:

• trunk/src/VBox/Runtime/common/time/time.cpp (modified) (4 diffs)

trunk/src/VBox/Runtime/common/time/time.cpp

@@ -800 +800 @@
 
 /**
+ * Converts a time spec to a ISO date string, extended version.
+ *
+ * @returns Output string length on success (positive), VERR_BUFFER_OVERFLOW
+ *          (negative) or VERR_OUT_OF_RANGE (negative) on failure.
+ * @param   pTime           The time. Caller should've normalized this.
+ * @param   psz             Where to store the string.
+ * @param   cb              The size of the buffer.
+ * @param   cFractionDigits Number of digits in the fraction.  Max is 9.
+ */
+RTDECL(ssize_t) RTTimeToStringEx(PCRTTIME pTime, char *psz, size_t cb, unsigned cFractionDigits)
+{
+    size_t cch;
+
+    /* Format the fraction. */
+    char szFraction[16];
+    if (!cFractionDigits)
+        szFraction[0] = '\0';
+    else
+    {
+        AssertReturn(cFractionDigits <= 9, VERR_OUT_OF_RANGE);
+        Assert(pTime->u32Nanosecond <= 999999999);
+        RTStrPrintf(szFraction, sizeof(szFraction), ".%09RU32", pTime->u32Nanosecond);
+        szFraction[cFractionDigits + 1] = '\0';
+    }
+
+    /* (Default to UTC if not specified) */
+    if (    (pTime->fFlags & RTTIME_FLAGS_TYPE_MASK) == RTTIME_FLAGS_TYPE_LOCAL
+        &&  pTime->offUTC)
+    {
+        int32_t  offUTC = pTime->offUTC;
+        Assert(offUTC <= 840 && offUTC >= -840);
+        char     chSign;
+        if (offUTC >= 0)
+            chSign = '+';
+        else
+        {
+            chSign = '-';
+            offUTC = -offUTC;
+        }
+        uint32_t offUTCHour   = (uint32_t)offUTC / 60;
+        uint32_t offUTCMinute = (uint32_t)offUTC % 60;
+
+        /* Examples: 2018-09-07T16:12:00+02:00  2018-09-07T16:12:00.123456789+02:00 */
+        cch = RTStrPrintf(psz, cb,
+                          "%04RI32-%02u-%02uT%02u:%02u:%02u%s%c%02d%:02d",
+                          pTime->i32Year, pTime->u8Month, pTime->u8MonthDay,
+                          pTime->u8Hour, pTime->u8Minute, pTime->u8Second, szFraction,
+                          chSign, offUTCHour, offUTCMinute);
+        if (   cch >= 24
+            && psz[cch - 6] == chSign)
+            return cch;
+    }
+    else
+    {
+        /* Examples: 2018-09-07T16:12:00Z  2018-09-07T16:12:00.123456789Z */
+        cch = RTStrPrintf(psz, cb, "%04RI32-%02u-%02uT%02u:%02u:%02u%sZ",
+                          pTime->i32Year, pTime->u8Month, pTime->u8MonthDay,
+                          pTime->u8Hour, pTime->u8Minute, pTime->u8Second, szFraction);
+        if (   cch >= 19
+            && psz[cch - 1] == 'Z')
+            return cch;
+    }
+    return VERR_BUFFER_OVERFLOW;
+}
+RT_EXPORT_SYMBOL(RTTimeToStringEx);
+
+
+/**
  * Converts a time spec to a ISO date string.
  *
@@ -841 +909 @@
 
     /*
-     * The day part.
+     * The date part.
      */
 
@@ -912 +980 @@
         return NULL;
 
-    /* Nanoseconds is optional and probably non-standard. */
+    /* Just in case there is a fraction of seconds (should be!). */
     if (*pszString == '.')
     {
+        const char * const pszStart = pszString;
         rc = RTStrToUInt32Ex(pszString + 1, (char **)&pszString, 10, &pTime->u32Nanosecond);
         if (rc != VINF_SUCCESS && rc != VWRN_TRAILING_CHARS && rc != VWRN_TRAILING_SPACES)
             return NULL;
+        if (pTime->u32Nanosecond >= 1000000000)
+            return NULL;
+        switch (pszString - pszStart)
+        {
+            case 1: pTime->u32Nanosecond *= 100000000; break;
+            case 2: pTime->u32Nanosecond *= 10000000; break;
+            case 3: pTime->u32Nanosecond *= 1000000; break;
+            case 4: pTime->u32Nanosecond *= 100000; break;
+            case 5: pTime->u32Nanosecond *= 10000; break;
+            case 6: pTime->u32Nanosecond *= 1000; break;
+            case 7: pTime->u32Nanosecond *= 100; break;
+            case 8: pTime->u32Nanosecond *= 10; break;
+            case 9: break;
+            default:
+                return NULL;
+        }
         if (pTime->u32Nanosecond >= 1000000000)
             return NULL;
@@ -1059 +1144 @@
 }
 RT_EXPORT_SYMBOL(RTTimeToRfc2822);
+
+
+/**
+ * Attempts to convert an RFC-2822 date string to a time structure.
+ *
+ * We're a little forgiving with zero padding, unspecified parts, and leading
+ * and trailing spaces.
+ *
+ * @retval  pTime on success,
+ * @retval  NULL on failure.
+ * @param   pTime       Where to store the time on success.
+ * @param   pszString   The ISO date string to convert.
+ */
+RTDECL(PRTTIME) RTTimeFromRfc2822(PRTTIME pTime, const char *pszString)
+{
+    /*
+     * Fri, 31 Aug 2018 00:00:00 +0200
+     * Mon, 3 Sep 2018 00:00:00 GMT
+     * Mon, 3 Sep 2018 00:00:00 -0000
+     * 3 Sep 2018 00:00:00 -0000 (?)
+     * 3 Sep 2018 00:00:00 GMT   (?)
+     *
+     */
+
+    /* Ignore leading spaces. */
+    while (RT_C_IS_SPACE(*pszString))
+        pszString++;
+
+    /*
+     * Init non date & time parts.
+     */
+    pTime->fFlags = RTTIME_FLAGS_TYPE_LOCAL;
+    pTime->offUTC = 0;
+
+    /*
+     * The date part.
+     */
+
+    /* Optional day of week: */
+    if (RT_C_IS_ALPHA(pszString[0]))
+        pTime->u8WeekDay = UINT8_MAX;
+    else if (pszString[0] != '\0' && pszString[1] != '\0')
+    {
+        uint32_t uWeekDay = RT_MAKE_U32_FROM_U8(RT_C_TO_LOWER(pszString[0]), RT_C_TO_LOWER(pszString[0]),
+                                                RT_C_TO_LOWER(pszString[1]), 0);
+        if (     uWeekDay == RT_MAKE_U32_FROM_U8('m', 'o', 'n', 0))     pTime->u8WeekDay = 0;
+        else if (uWeekDay == RT_MAKE_U32_FROM_U8('t', 'u', 'e', 0))     pTime->u8WeekDay = 1;
+        else if (uWeekDay == RT_MAKE_U32_FROM_U8('w', 'e', 'd', 0))     pTime->u8WeekDay = 2;
+        else if (uWeekDay == RT_MAKE_U32_FROM_U8('t', 'h', 'u', 0))     pTime->u8WeekDay = 3;
+        else if (uWeekDay == RT_MAKE_U32_FROM_U8('f', 'r', 'i', 0))     pTime->u8WeekDay = 4;
+        else if (uWeekDay == RT_MAKE_U32_FROM_U8('s', 'a', 't', 0))     pTime->u8WeekDay = 5;
+        else if (uWeekDay == RT_MAKE_U32_FROM_U8('s', 'u', 'n', 0))     pTime->u8WeekDay = 6;
+        else
+            return NULL;
+        pszString += 3;
+        while (RT_C_IS_ALPHA(*pszString))
+            pszString++;
+        if (*pszString == ',')
+            pszString++;
+        while (RT_C_IS_SPACE(*pszString))
+            pszString++;
+        if (!RT_C_IS_DIGIT(pszString[0]))
+            return NULL;
+    }
+    else
+        return NULL;
+
+    /* Day of month.*/
+    int rc = RTStrToUInt8Ex(pszString, (char **)&pszString, 10, &pTime->u8MonthDay);
+    if (rc != VWRN_TRAILING_CHARS && rc != VINF_SUCCESS)
+        return NULL;
+    while (RT_C_IS_SPACE(*pszString))
+        pszString++;
+
+    /* Month of the year. */
+    if (pszString[0] == '\0' || pszString[1] == '\0' || pszString[2] == '\0')
+        return NULL;
+    uint32_t uMonth = RT_MAKE_U32_FROM_U8(RT_C_TO_LOWER(pszString[0]), RT_C_TO_LOWER(pszString[0]),
+                                          RT_C_TO_LOWER(pszString[1]), 0);
+    if (     uMonth == RT_MAKE_U32_FROM_U8('j', 'a', 'n', 0))     pTime->u8Month = 1;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('f', 'e', 'b', 0))     pTime->u8Month = 2;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('m', 'a', 'r', 0))     pTime->u8Month = 3;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('a', 'p', 'r', 0))     pTime->u8Month = 4;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('m', 'a', 'y', 0))     pTime->u8Month = 5;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('j', 'u', 'n', 0))     pTime->u8Month = 6;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('j', 'u', 'l', 0))     pTime->u8Month = 7;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('a', 'u', 'g', 0))     pTime->u8Month = 8;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('s', 'e', 'p', 0))     pTime->u8Month = 9;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('o', 'c', 't', 0))     pTime->u8Month = 10;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('n', 'o', 'v', 0))     pTime->u8Month = 11;
+    else if (uMonth == RT_MAKE_U32_FROM_U8('d', 'e', 'c', 0))     pTime->u8Month = 12;
+    else
+        return NULL;
+    pszString += 3;
+    while (RT_C_IS_ALPHA(*pszString))
+        pszString++;
+    while (RT_C_IS_SPACE(*pszString))
+        pszString++;
+
+    /* Year */
+    rc = RTStrToInt32Ex(pszString, (char **)&pszString, 10, &pTime->i32Year);
+    if (rc != VWRN_TRAILING_CHARS)
+        return NULL;
+
+    bool const fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
+    if (fLeapYear)
+        pTime->fFlags |= RTTIME_FLAGS_LEAP_YEAR;
+
+    while (RT_C_IS_SPACE(*pszString))
+        pszString++;
+
+
+    /* Calculate year day. */
+    unsigned const cDaysInMonth = fLeapYear
+                                ? g_acDaysInMonthsLeap[pTime->u8Month - 1]
+                                : g_acDaysInMonths[pTime->u8Month - 1];
+    if (pTime->u8MonthDay == 0 || pTime->u8MonthDay > cDaysInMonth)
+        return NULL;
+
+    pTime->u16YearDay = pTime->u8MonthDay - 1
+                      + (fLeapYear
+                         ? g_aiDayOfYearLeap[pTime->u8Month - 1]
+                         : g_aiDayOfYear[pTime->u8Month - 1]);
+
+    /*
+     * The time part.
+     */
+    /* Hour. */
+    rc = RTStrToUInt8Ex(pszString, (char **)&pszString, 10, &pTime->u8Hour);
+    if (rc != VWRN_TRAILING_CHARS)
+        return NULL;
+    if (pTime->u8Hour > 23)
+        return NULL;
+    if (*pszString++ != ':')
+        return NULL;
+
+    /* Minute. */
+    rc = RTStrToUInt8Ex(pszString, (char **)&pszString, 10, &pTime->u8Minute);
+    if (rc != VWRN_TRAILING_CHARS)
+        return NULL;
+    if (pTime->u8Minute > 59)
+        return NULL;
+    if (*pszString++ != ':')
+        return NULL;
+
+    /* Second. */
+    rc = RTStrToUInt8Ex(pszString, (char **)&pszString, 10, &pTime->u8Second);
+    if (rc != VINF_SUCCESS && rc != VWRN_TRAILING_CHARS && rc != VWRN_TRAILING_SPACES)
+        return NULL;
+    if (pTime->u8Second > 59)
+        return NULL;
+
+    /* Nanoseconds  and probably non-standard. */
+    if (*pszString == '.')
+    {
+        const char * const pszStart = pszString;
+        rc = RTStrToUInt32Ex(pszString + 1, (char **)&pszString, 10, &pTime->u32Nanosecond);
+        if (rc != VINF_SUCCESS && rc != VWRN_TRAILING_CHARS && rc != VWRN_TRAILING_SPACES)
+            return NULL;
+        if (pTime->u32Nanosecond >= 1000000000)
+            return NULL;
+        switch (pszString - pszStart)
+        {
+            case 1: pTime->u32Nanosecond *= 100000000; break;
+            case 2: pTime->u32Nanosecond *= 10000000; break;
+            case 3: pTime->u32Nanosecond *= 1000000; break;
+            case 4: pTime->u32Nanosecond *= 100000; break;
+            case 5: pTime->u32Nanosecond *= 10000; break;
+            case 6: pTime->u32Nanosecond *= 1000; break;
+            case 7: pTime->u32Nanosecond *= 100; break;
+            case 8: pTime->u32Nanosecond *= 10; break;
+            case 9: break;
+            default:
+                return NULL;
+        }
+        if (pTime->u32Nanosecond >= 1000000000)
+            return NULL;
+    }
+    else
+        pTime->u32Nanosecond = 0;
+
+    /*
+     * Time zone.
+     */
+    if (   (pszString[0] == 'G' || pszString[0] == 'g')
+        && (pszString[1] == 'M' || pszString[1] == 'm')
+        && (pszString[2] == 'T' || pszString[2] == 't') )
+    {
+        pszString++;
+        pTime->fFlags &= ~RTTIME_FLAGS_TYPE_MASK;
+        pTime->fFlags |= ~RTTIME_FLAGS_TYPE_UTC;
+        pTime->offUTC = 0;
+    }
+    else if (   *pszString == '+'
+             || *pszString == '-')
+    {
+        if (   !RT_C_IS_DIGIT(pszString[1])
+            || !RT_C_IS_DIGIT(pszString[2]))
+            return NULL;
+        int8_t cUtcHours = (pszString[1] - '0') * 10 + (pszString[2] - '0');
+        if (*pszString == '-')
+            cUtcHours = -cUtcHours;
+        pszString += 3;
+
+        uint8_t cUtcMin = 0;
+        if (RT_C_IS_DIGIT(pszString[0]))
+        {
+            rc = RTStrToUInt8Ex(pszString, (char **)&pszString, 10, &cUtcMin);
+            if (rc != VINF_SUCCESS && rc != VWRN_TRAILING_SPACES)
+                return NULL;
+        }
+        else if (*pszString && !RT_C_IS_BLANK(*pszString))
+            return NULL;
+        if (cUtcHours >= 0)
+            pTime->offUTC = cUtcHours * 60 + cUtcMin;
+        else
+            pTime->offUTC = cUtcHours * 60 - cUtcMin;
+        if (RT_ABS(pTime->offUTC) > 840)
+            return NULL;
+    }
+    /* else: No time zone given, local with offUTC = 0. */
+
+    /*
+     * The rest of the string should be blanks.
+     */
+    char ch;
+    while ((ch = *pszString++) != '\0')
+        if (!RT_C_IS_BLANK(ch))
+            return NULL;
+
+    return pTime;
+}
+RT_EXPORT_SYMBOL(RTTimeFromRfc2822);