Changeset 74069 in vbox for trunk

Timestamp:

Sep 4, 2018 3:15:21 PM (6 years ago)

Author:

vboxsync

Message:

IPRT/time: Added RTTimeToRfc2822 for formatting time according to RFC-2822. bugref:9167

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (1 diff)
• include/iprt/time.h (modified) (1 diff)
• src/VBox/Runtime/common/time/time.cpp (modified) (2 diffs)

trunk/include/iprt/mangling.h

@@ -2396 +2396 @@
 # define RTTimeFromString                               RT_MANGLER(RTTimeFromString)
 # define RTTimeToString                                 RT_MANGLER(RTTimeToString)
+# define RTTimeToRfc2822                                RT_MANGLER(RTTimeToRfc2822)
 # define RTTimeZoneGetInfoByUnixName                    RT_MANGLER(RTTimeZoneGetInfoByUnixName)
 # define RTTimeZoneGetInfoByWindowsName                 RT_MANGLER(RTTimeZoneGetInfoByWindowsName)

trunk/include/iprt/time.h

@@ -803 +803 @@
 
 /**
+ * Formats the given time on a RTC-2822 compliant format.
+ *
+ * @returns Output string length on success (positive), VERR_BUFFER_OVERFLOW
+ *          (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.
+ * @sa      RTTIME_RTC2822_LEN
+ */
+RTDECL(ssize_t) RTTimeToRfc2822(PRTTIME pTime, char *psz, size_t cb);
+
+/** Suggested buffer length for RTTimeToRfc2822 output, including terminator. */
+#define RTTIME_RTC2822_LEN      40
+
+/**
  * Checks if a year is a leap year or not.
  *

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

@@ -237 +237 @@
 */
 
+/** RFC-1123 week day names. */
+static const char * const g_apszWeekDays[7] =
+{
+    "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
+};
+/** RFC-1123 month of the year names. */
+static const char * const g_apszMonths[1+12] =
+{
+    "000", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
+};
+
 
 /**
@@ -983 +994 @@
 
 /**
+ * Formats the given time on a RTC-2822 compliant format.
+ *
+ * @returns Output string length on success (positive), VERR_BUFFER_OVERFLOW
+ *          (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.
+ */
+RTDECL(ssize_t) RTTimeToRfc2822(PRTTIME pTime, char *psz, size_t cb)
+{
+    Assert(pTime->u8Month > 0 && pTime->u8Month <= 12);
+    Assert(pTime->u8WeekDay < 7);
+
+    /* (Default to UTC if not specified) */
+    if (   (pTime->fFlags & RTTIME_FLAGS_TYPE_MASK) == RTTIME_FLAGS_TYPE_LOCAL
+        && pTime->offUTC)
+    {
+        /* Calc the UTC offset part. */
+        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;
+
+        /* Example:                       "Mon, 31 Aug 2018 00:00:00 +0200" */
+        size_t cch = RTStrPrintf(psz, cb, "%s, %u %s %04RI32 %02u:%02u:%02u %c%02u%02u", g_apszWeekDays[pTime->u8WeekDay],
+                                 pTime->u8MonthDay, g_apszMonths[pTime->u8Month], pTime->i32Year,
+                                 pTime->u8Hour, pTime->u8Minute, pTime->u8Second, chSign, offUtcHour, offUtcMinute);
+        if (   cch >= 27
+            && psz[cch - 5] == chSign)
+            return cch;
+    }
+    else
+    {
+        /* Example:                       "Mon, 1 Jan 1971 00:00:00 -0000" */
+        size_t cch = RTStrPrintf(psz, cb, "%s, %u %s %04RI32 %02u:%02u:%02u -0000", g_apszWeekDays[pTime->u8WeekDay],
+                                 pTime->u8MonthDay, g_apszMonths[pTime->u8Month], pTime->i32Year,
+                                 pTime->u8Hour, pTime->u8Minute, pTime->u8Second);
+        if (   cch >= 27
+            && psz[cch - 5] == '-')
+            return cch;
+    }
+    return VERR_BUFFER_OVERFLOW;
+}
+RT_EXPORT_SYMBOL(RTTimeToRfc2822);
+
+
+/**
  * Adds one day to @a pTime.
  *