[exim.git] / src / src / tod.c

/*************************************************
*     Exim - an Internet mail transport agent    *
*************************************************/

/* Copyright (c) University of Cambridge 1995 - 2014 */
/* See the file NOTICE for conditions of use and distribution. */

/* A function for returning the time of day in various formats */


#include "exim.h"

/* #define TESTING_LOG_DATESTAMP */


static uschar timebuf[sizeof("www, dd-mmm-yyyy hh:mm:ss.ddd +zzzz")];


/*************************************************
*                Return timestamp                *
*************************************************/

/* The log timestamp format is dd-mmm-yy so as to be non-confusing on both
sides of the Atlantic. We calculate an explicit numerical offset from GMT for
the full datestamp and BSD inbox datestamp. Note that on some systems
localtime() and gmtime() re-use the same store, so we must save the local time
values before calling gmtime(). If timestamps_utc is set, don't use
localtime(); all times are then in UTC (with offset +0000).

There are also some contortions to get the day of the month without
a leading zero for the full stamp, since Ustrftime() doesn't provide this
option.

Argument:  type of timestamp required:
             tod_bsdin                  BSD inbox format
             tod_epoch                  Unix epoch format
             tod_epochl                 Unix epoch/usec format
             tod_full                   full date and time
             tod_log                    log file data line format,
                                          with zone if log_timezone is TRUE
             tod_log_bare               always without zone
             tod_log_datestamp_daily    for log file names when datestamped daily
             tod_log_datestamp_monthly  for log file names when datestamped monthly
             tod_log_zone               always with zone
             tod_mbx                    MBX inbox format
             tod_zone                   just the timezone offset
             tod_zulu                   time in 8601 zulu format

Returns:   pointer to fixed buffer containing the timestamp
*/

uschar *
tod_stamp(int type)
{
struct timeval now;
struct tm * t;
int off = 0;

gettimeofday(&now, NULL);

/* Styles that don't need local time */

switch(type)
  {
  case tod_epoch:
    (void) sprintf(CS timebuf, TIME_T_FMT, now.tv_sec);  /* Unix epoch format */
    return timebuf;	/* NB the above will be wrong if time_t is FP */

  case tod_epoch_l:
    /* Unix epoch/usec format */
    (void) sprintf(CS timebuf, TIME_T_FMT "%06ld", now.tv_sec, (long) now.tv_usec );
    return timebuf;

  case tod_zulu:
    t = gmtime(&now.tv_sec);
    (void) sprintf(CS timebuf, "%04d%02d%02d%02d%02d%02dZ",
      1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday, t->tm_hour, t->tm_min,
      t->tm_sec);
    return timebuf;
  }

/* Vary log type according to timezone requirement */

if (type == tod_log) type = log_timezone ? tod_log_zone : tod_log_bare;

/* Convert to local time or UTC */

t = timestamps_utc ? gmtime(&now.tv_sec) : localtime(&now.tv_sec);

switch(type)
  {
  case tod_log_bare:          /* Format used in logging without timezone */
    off = sprintf(CS timebuf, "%04d-%02d-%02d %02d:%02d:%02d",
      1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday,
      t->tm_hour, t->tm_min, t->tm_sec);
    break;

    /* Format used as suffix of log file name when 'log_datestamp' is active. For
    testing purposes, it changes the file every second. */

#ifdef TESTING_LOG_DATESTAMP
  case tod_log_datestamp_daily:
  case tod_log_datestamp_monthly:
    off = sprintf(CS timebuf, "%04d%02d%02d%02d%02d",
      1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday, t->tm_hour, t->tm_min);
    break;

#else
  case tod_log_datestamp_daily:
    off = sprintf(CS timebuf, "%04d%02d%02d",
      1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday);
    break;

  case tod_log_datestamp_monthly:
    off = sprintf(CS timebuf, "%04d%02d",
      1900 + t->tm_year, 1 + t->tm_mon);
    break;
#endif

    /* Format used in BSD inbox separator lines. Sort-of documented in RFC 976
    ("UUCP Mail Interchange Format Standard") but only by example, not by
    explicit definition. The examples show no timezone offsets, and some MUAs
    appear to be sensitive to this, so Exim has been changed to remove the
    timezone offsets that originally appeared. */

  case tod_bsdin:
      {
      int len = Ustrftime(timebuf, sizeof(timebuf), "%a %b %d %H:%M:%S", t);
      Ustrftime(timebuf + len, sizeof(timebuf) - len, " %Y", t);
      }
    break;

    /* Other types require the GMT offset to be calculated, or just set up in the
    case of UTC timestamping. We need to take a copy of the local time first. */

  default:
      {
      int diff_hour, diff_min;
      struct tm local;
      memcpy(&local, t, sizeof(struct tm));

      if (timestamps_utc)
	diff_hour = diff_min = 0;
      else
	{
	struct tm * gmt = gmtime(&now.tv_sec);

	diff_min = 60*(local.tm_hour - gmt->tm_hour) + local.tm_min - gmt->tm_min;
	if (local.tm_year != gmt->tm_year)
	  diff_min += (local.tm_year > gmt->tm_year)? 1440 : -1440;
	else if (local.tm_yday != gmt->tm_yday)
	  diff_min += (local.tm_yday > gmt->tm_yday)? 1440 : -1440;
	diff_hour = diff_min/60;
	diff_min  = abs(diff_min - diff_hour*60);
	}

      switch(type)
	{
	case tod_log_zone:          /* Format used in logging with timezone */
#ifndef COMPILE_UTILITY
	  if (LOGGING(millisec))
	    (void) sprintf(CS timebuf,
	      "%04d-%02d-%02d %02d:%02d:%02d.%03d %+03d%02d",
	      1900 + local.tm_year, 1 + local.tm_mon, local.tm_mday,
	      local.tm_hour, local.tm_min, local.tm_sec, now.tv_usec/1000,
	      diff_hour, diff_min);
	  else
#endif
	    (void) sprintf(CS timebuf,
	      "%04d-%02d-%02d %02d:%02d:%02d %+03d%02d",
	      1900 + local.tm_year, 1 + local.tm_mon, local.tm_mday,
	      local.tm_hour, local.tm_min, local.tm_sec,
	      diff_hour, diff_min);
	  break;

	case tod_zone:              /* Just the timezone offset */
	  (void) sprintf(CS timebuf, "%+03d%02d", diff_hour, diff_min);
	  break;

	/* tod_mbx: format used in MBX mailboxes - subtly different to tod_full */

	  #ifdef SUPPORT_MBX
	case tod_mbx:
	    {
	    int len;
	    (void) sprintf(CS timebuf, "%02d-", local.tm_mday);
	    len = Ustrlen(timebuf);
	    len += Ustrftime(timebuf + len, sizeof(timebuf) - len, "%b-%Y %H:%M:%S",
	      &local);
	    (void) sprintf(CS timebuf + len, " %+03d%02d", diff_hour, diff_min);
	    }
	  break;
	  #endif

	/* tod_full: format used in Received: headers (use as default just in case
	called with a junk type value) */

	default:
	    {
	    int len = Ustrftime(timebuf, sizeof(timebuf), "%a, ", &local);
	    (void) sprintf(CS timebuf + len, "%02d ", local.tm_mday);
	    len += Ustrlen(timebuf + len);
	    len += Ustrftime(timebuf + len, sizeof(timebuf) - len, "%b %Y %H:%M:%S",
	      &local);
	    (void) sprintf(CS timebuf + len, " %+03d%02d", diff_hour, diff_min);
	    }
	  break;
	}
      }
    break;
  }

#ifndef COMPILE_UTILITY
if (LOGGING(millisec) && off > 0)
  (void) sprintf(CS timebuf + off, ".%03d", now.tv_usec/1000);
#endif

return timebuf;
}

/* End of tod.c */
Commit	Line	Data
059ec3d9 PH	1	/*************************************************
	2	* Exim - an Internet mail transport agent *
	3	*************************************************/
	4
8d6d5106	5	/* Copyright (c) University of Cambridge 1995 - 2014 */
059ec3d9 PH	6	/* See the file NOTICE for conditions of use and distribution. */
	7
	8	/* A function for returning the time of day in various formats */
	9
	10
	11	#include "exim.h"
	12
	13	/* #define TESTING_LOG_DATESTAMP */
	14
	15
571b2715	16	static uschar timebuf[sizeof("www, dd-mmm-yyyy hh:mm:ss.ddd +zzzz")];
059ec3d9 PH	17
	18
	19	/*************************************************
	20	* Return timestamp *
	21	*************************************************/
	22
	23	/* The log timestamp format is dd-mmm-yy so as to be non-confusing on both
	24	sides of the Atlantic. We calculate an explicit numerical offset from GMT for
	25	the full datestamp and BSD inbox datestamp. Note that on some systems
	26	localtime() and gmtime() re-use the same store, so we must save the local time
	27	values before calling gmtime(). If timestamps_utc is set, don't use
	28	localtime(); all times are then in UTC (with offset +0000).
	29
	30	There are also some contortions to get the day of the month without
	31	a leading zero for the full stamp, since Ustrftime() doesn't provide this
	32	option.
	33
	34	Argument: type of timestamp required:
f1e5fef5 PP	35	tod_bsdin BSD inbox format
f1e5fef5 PP	36	tod_epoch Unix epoch format
f5787926	37	tod_epochl Unix epoch/usec format
f1e5fef5 PP	38	tod_full full date and time
	39	tod_log log file data line format,
	40	with zone if log_timezone is TRUE
	41	tod_log_bare always without zone
	42	tod_log_datestamp_daily for log file names when datestamped daily
	43	tod_log_datestamp_monthly for log file names when datestamped monthly
	44	tod_log_zone always with zone
	45	tod_mbx MBX inbox format
	46	tod_zone just the timezone offset
	47	tod_zulu time in 8601 zulu format
059ec3d9 PH	48
	49	Returns: pointer to fixed buffer containing the timestamp
	50	*/
	51
	52	uschar *
	53	tod_stamp(int type)
	54	{
571b2715 JH	55	struct timeval now;
	56	struct tm * t;
	57	int off = 0;
059ec3d9	58
571b2715	59	gettimeofday(&now, NULL);
059ec3d9 PH	60
	61	/* Styles that don't need local time */
	62
571b2715	63	switch(type)
059ec3d9	64	{
571b2715 JH	65	case tod_epoch:
	66	(void) sprintf(CS timebuf, TIME_T_FMT, now.tv_sec); /* Unix epoch format */
	67	return timebuf; /* NB the above will be wrong if time_t is FP */
	68
	69	case tod_epoch_l:
	70	/* Unix epoch/usec format */
	71	(void) sprintf(CS timebuf, TIME_T_FMT "%06ld", now.tv_sec, (long) now.tv_usec );
	72	return timebuf;
	73
	74	case tod_zulu:
	75	t = gmtime(&now.tv_sec);
	76	(void) sprintf(CS timebuf, "%04d%02d%02d%02d%02d%02dZ",
	77	1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday, t->tm_hour, t->tm_min,
	78	t->tm_sec);
	79	return timebuf;
059ec3d9 PH	80	}
059ec3d9 PH	81
571b2715 JH	82	/* Vary log type according to timezone requirement */
	83
	84	if (type == tod_log) type = log_timezone ? tod_log_zone : tod_log_bare;
059ec3d9 PH	85
	86	/* Convert to local time or UTC */
	87
571b2715	88	t = timestamps_utc ? gmtime(&now.tv_sec) : localtime(&now.tv_sec);
059ec3d9 PH	89
	90	switch(type)
	91	{
	92	case tod_log_bare: /* Format used in logging without timezone */
571b2715 JH	93	off = sprintf(CS timebuf, "%04d-%02d-%02d %02d:%02d:%02d",
	94	1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday,
	95	t->tm_hour, t->tm_min, t->tm_sec);
	96	break;
059ec3d9	97
571b2715 JH	98	/* Format used as suffix of log file name when 'log_datestamp' is active. For
571b2715 JH	99	testing purposes, it changes the file every second. */
059ec3d9	100
571b2715	101	#ifdef TESTING_LOG_DATESTAMP
f1e5fef5 PP	102	case tod_log_datestamp_daily:
f1e5fef5 PP	103	case tod_log_datestamp_monthly:
571b2715 JH	104	off = sprintf(CS timebuf, "%04d%02d%02d%02d%02d",
	105	1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday, t->tm_hour, t->tm_min);
	106	break;
f1e5fef5	107
571b2715	108	#else
f1e5fef5	109	case tod_log_datestamp_daily:
571b2715 JH	110	off = sprintf(CS timebuf, "%04d%02d%02d",
	111	1900 + t->tm_year, 1 + t->tm_mon, t->tm_mday);
	112	break;
059ec3d9	113
f1e5fef5	114	case tod_log_datestamp_monthly:
571b2715 JH	115	off = sprintf(CS timebuf, "%04d%02d",
	116	1900 + t->tm_year, 1 + t->tm_mon);
	117	break;
	118	#endif
f1e5fef5	119
571b2715 JH	120	/* Format used in BSD inbox separator lines. Sort-of documented in RFC 976
	121	("UUCP Mail Interchange Format Standard") but only by example, not by
	122	explicit definition. The examples show no timezone offsets, and some MUAs
	123	appear to be sensitive to this, so Exim has been changed to remove the
	124	timezone offsets that originally appeared. */
059ec3d9 PH	125
059ec3d9 PH	126	case tod_bsdin:
059ec3d9	127	{
571b2715 JH	128	int len = Ustrftime(timebuf, sizeof(timebuf), "%a %b %d %H:%M:%S", t);
571b2715 JH	129	Ustrftime(timebuf + len, sizeof(timebuf) - len, " %Y", t);
059ec3d9	130	}
571b2715 JH	131	break;
	132
	133	/* Other types require the GMT offset to be calculated, or just set up in the
	134	case of UTC timestamping. We need to take a copy of the local time first. */
059ec3d9	135
571b2715	136	default:
059ec3d9	137	{
571b2715 JH	138	int diff_hour, diff_min;
	139	struct tm local;
	140	memcpy(&local, t, sizeof(struct tm));
	141
	142	if (timestamps_utc)
	143	diff_hour = diff_min = 0;
	144	else
	145	{
	146	struct tm * gmt = gmtime(&now.tv_sec);
	147
	148	diff_min = 60*(local.tm_hour - gmt->tm_hour) + local.tm_min - gmt->tm_min;
	149	if (local.tm_year != gmt->tm_year)
	150	diff_min += (local.tm_year > gmt->tm_year)? 1440 : -1440;
	151	else if (local.tm_yday != gmt->tm_yday)
	152	diff_min += (local.tm_yday > gmt->tm_yday)? 1440 : -1440;
	153	diff_hour = diff_min/60;
	154	diff_min = abs(diff_min - diff_hour*60);
	155	}
	156
	157	switch(type)
	158	{
	159	case tod_log_zone: /* Format used in logging with timezone */
	160	#ifndef COMPILE_UTILITY
	161	if (LOGGING(millisec))
	162	(void) sprintf(CS timebuf,
	163	"%04d-%02d-%02d %02d:%02d:%02d.%03d %+03d%02d",
	164	1900 + local.tm_year, 1 + local.tm_mon, local.tm_mday,
	165	local.tm_hour, local.tm_min, local.tm_sec, now.tv_usec/1000,
	166	diff_hour, diff_min);
	167	else
	168	#endif
	169	(void) sprintf(CS timebuf,
	170	"%04d-%02d-%02d %02d:%02d:%02d %+03d%02d",
	171	1900 + local.tm_year, 1 + local.tm_mon, local.tm_mday,
	172	local.tm_hour, local.tm_min, local.tm_sec,
	173	diff_hour, diff_min);
	174	break;
	175
	176	case tod_zone: /* Just the timezone offset */
	177	(void) sprintf(CS timebuf, "%+03d%02d", diff_hour, diff_min);
	178	break;
	179
	180	/* tod_mbx: format used in MBX mailboxes - subtly different to tod_full */
	181
	182	#ifdef SUPPORT_MBX
	183	case tod_mbx:
	184	{
	185	int len;
	186	(void) sprintf(CS timebuf, "%02d-", local.tm_mday);
	187	len = Ustrlen(timebuf);
	188	len += Ustrftime(timebuf + len, sizeof(timebuf) - len, "%b-%Y %H:%M:%S",
	189	&local);
	190	(void) sprintf(CS timebuf + len, " %+03d%02d", diff_hour, diff_min);
	191	}
	192	break;
	193	#endif
	194
	195	/* tod_full: format used in Received: headers (use as default just in case
	196	called with a junk type value) */
	197
	198	default:
	199	{
	200	int len = Ustrftime(timebuf, sizeof(timebuf), "%a, ", &local);
	201	(void) sprintf(CS timebuf + len, "%02d ", local.tm_mday);
202	len += Ustrlen(timebuf + len);
203	len += Ustrftime(timebuf + len, sizeof(timebuf) - len, "%b %Y %H:%M:%S",
204	&local);
205	(void) sprintf(CS timebuf + len, " %+03d%02d", diff_hour, diff_min);
206	}
207	break;
208	}
059ec3d9	209	}
571b2715	210	break;
059ec3d9 PH	211	}
059ec3d9 PH	212
571b2715 JH	213	#ifndef COMPILE_UTILITY
	214	if (LOGGING(millisec) && off > 0)
	215	(void) sprintf(CS timebuf + off, ".%03d", now.tv_usec/1000);
	216	#endif
	217
059ec3d9 PH	218	return timebuf;
	219	}
	220
	221	/* End of tod.c */