skel_ -> cap_
[Samba/gebeck_regimport.git] / source3 / lib / time.c
blob5309711a056ed316e3e5a6b7f184f197fd192f0a
1 /*
2 Unix SMB/CIFS implementation.
3 time handling functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Stefan (metze) Metzmacher 2002
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "includes.h"
24 This stuff was largely rewritten by Paul Eggert <eggert@twinsun.com>
25 in May 1996
29 int extra_time_offset = 0;
31 #ifndef CHAR_BIT
32 #define CHAR_BIT 8
33 #endif
35 #ifndef TIME_T_MIN
36 #define TIME_T_MIN ((time_t)0 < (time_t) -1 ? (time_t) 0 \
37 : ~ (time_t) 0 << (sizeof (time_t) * CHAR_BIT - 1))
38 #endif
39 #ifndef TIME_T_MAX
40 #define TIME_T_MAX (~ (time_t) 0 - TIME_T_MIN)
41 #endif
43 void get_nttime_max(NTTIME *t)
45 /* FIXME: This is incorrect */
46 unix_to_nt_time(t, get_time_t_max());
49 /*******************************************************************
50 External access to time_t_min and time_t_max.
51 ********************************************************************/
53 time_t get_time_t_max(void)
55 return TIME_T_MAX;
58 /*******************************************************************
59 a gettimeofday wrapper
60 ********************************************************************/
61 void GetTimeOfDay(struct timeval *tval)
63 #ifdef HAVE_GETTIMEOFDAY_TZ
64 gettimeofday(tval,NULL);
65 #else
66 gettimeofday(tval);
67 #endif
70 #define TM_YEAR_BASE 1900
72 /*******************************************************************
73 yield the difference between *A and *B, in seconds, ignoring leap seconds
74 ********************************************************************/
75 static int tm_diff(struct tm *a, struct tm *b)
77 int ay = a->tm_year + (TM_YEAR_BASE - 1);
78 int by = b->tm_year + (TM_YEAR_BASE - 1);
79 int intervening_leap_days =
80 (ay/4 - by/4) - (ay/100 - by/100) + (ay/400 - by/400);
81 int years = ay - by;
82 int days = 365*years + intervening_leap_days + (a->tm_yday - b->tm_yday);
83 int hours = 24*days + (a->tm_hour - b->tm_hour);
84 int minutes = 60*hours + (a->tm_min - b->tm_min);
85 int seconds = 60*minutes + (a->tm_sec - b->tm_sec);
87 return seconds;
90 /*******************************************************************
91 return the UTC offset in seconds west of UTC, or 0 if it cannot be determined
92 ******************************************************************/
93 static int TimeZone(time_t t)
95 struct tm *tm = gmtime(&t);
96 struct tm tm_utc;
97 if (!tm)
98 return 0;
99 tm_utc = *tm;
100 tm = localtime(&t);
101 if (!tm)
102 return 0;
103 return tm_diff(&tm_utc,tm);
107 static BOOL done_serverzone_init;
109 /* Return the smb serverzone value */
111 static int get_serverzone(void)
113 static int serverzone;
115 if (!done_serverzone_init) {
116 serverzone = TimeZone(time(NULL));
118 if ((serverzone % 60) != 0) {
119 DEBUG(1,("WARNING: Your timezone is not a multiple of 1 minute.\n"));
122 DEBUG(4,("Serverzone is %d\n",serverzone));
124 done_serverzone_init = True;
127 return serverzone;
130 /* Re-read the smb serverzone value */
132 static struct timeval start_time_hires;
134 void TimeInit(void)
136 done_serverzone_init = False;
137 get_serverzone();
138 /* Save the start time of this process. */
139 if (start_time_hires.tv_sec == 0 && start_time_hires.tv_usec == 0)
140 GetTimeOfDay(&start_time_hires);
143 /**********************************************************************
144 Return a timeval struct of the uptime of this process. As TimeInit is
145 done before a daemon fork then this is the start time from the parent
146 daemon start. JRA.
147 ***********************************************************************/
149 void get_process_uptime(struct timeval *ret_time)
151 struct timeval time_now_hires;
153 GetTimeOfDay(&time_now_hires);
154 ret_time->tv_sec = time_now_hires.tv_sec - start_time_hires.tv_sec;
155 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
156 if (time_now_hires.tv_usec < start_time_hires.tv_usec) {
157 ret_time->tv_sec -= 1;
158 ret_time->tv_usec = 1000000 + (time_now_hires.tv_usec - start_time_hires.tv_usec);
159 } else
160 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
163 /*******************************************************************
164 return the same value as TimeZone, but it should be more efficient.
166 We keep a table of DST offsets to prevent calling localtime() on each
167 call of this function. This saves a LOT of time on many unixes.
169 Updated by Paul Eggert <eggert@twinsun.com>
170 ********************************************************************/
171 static int TimeZoneFaster(time_t t)
173 static struct dst_table {time_t start,end; int zone;} *tdt, *dst_table = NULL;
174 static int table_size = 0;
175 int i;
176 int zone = 0;
178 if (t == 0) t = time(NULL);
180 /* Tunis has a 8 day DST region, we need to be careful ... */
181 #define MAX_DST_WIDTH (365*24*60*60)
182 #define MAX_DST_SKIP (7*24*60*60)
184 for (i=0;i<table_size;i++)
185 if (t >= dst_table[i].start && t <= dst_table[i].end) break;
187 if (i<table_size) {
188 zone = dst_table[i].zone;
189 } else {
190 time_t low,high;
192 zone = TimeZone(t);
193 tdt = (struct dst_table *)Realloc(dst_table,
194 sizeof(dst_table[0])*(i+1));
195 if (!tdt) {
196 DEBUG(0,("TimeZoneFaster: out of memory!\n"));
197 SAFE_FREE(dst_table);
198 table_size = 0;
199 } else {
200 dst_table = tdt;
201 table_size++;
203 dst_table[i].zone = zone;
204 dst_table[i].start = dst_table[i].end = t;
206 /* no entry will cover more than 6 months */
207 low = t - MAX_DST_WIDTH/2;
208 if (t < low)
209 low = TIME_T_MIN;
211 high = t + MAX_DST_WIDTH/2;
212 if (high < t)
213 high = TIME_T_MAX;
215 /* widen the new entry using two bisection searches */
216 while (low+60*60 < dst_table[i].start) {
217 if (dst_table[i].start - low > MAX_DST_SKIP*2)
218 t = dst_table[i].start - MAX_DST_SKIP;
219 else
220 t = low + (dst_table[i].start-low)/2;
221 if (TimeZone(t) == zone)
222 dst_table[i].start = t;
223 else
224 low = t;
227 while (high-60*60 > dst_table[i].end) {
228 if (high - dst_table[i].end > MAX_DST_SKIP*2)
229 t = dst_table[i].end + MAX_DST_SKIP;
230 else
231 t = high - (high-dst_table[i].end)/2;
232 if (TimeZone(t) == zone)
233 dst_table[i].end = t;
234 else
235 high = t;
237 #if 0
238 DEBUG(1,("Added DST entry from %s ",
239 asctime(localtime(&dst_table[i].start))));
240 DEBUG(1,("to %s (%d)\n",asctime(localtime(&dst_table[i].end)),
241 dst_table[i].zone));
242 #endif
245 return zone;
248 /****************************************************************************
249 return the UTC offset in seconds west of UTC, adjusted for extra time offset
250 **************************************************************************/
251 int TimeDiff(time_t t)
253 return TimeZoneFaster(t) + 60*extra_time_offset;
257 /****************************************************************************
258 return the UTC offset in seconds west of UTC, adjusted for extra time
259 offset, for a local time value. If ut = lt + LocTimeDiff(lt), then
260 lt = ut - TimeDiff(ut), but the converse does not necessarily hold near
261 daylight savings transitions because some local times are ambiguous.
262 LocTimeDiff(t) equals TimeDiff(t) except near daylight savings transitions.
263 +**************************************************************************/
264 static int LocTimeDiff(time_t lte)
266 time_t lt = lte - 60*extra_time_offset;
267 int d = TimeZoneFaster(lt);
268 time_t t = lt + d;
270 /* if overflow occurred, ignore all the adjustments so far */
271 if (((lte < lt) ^ (extra_time_offset < 0)) | ((t < lt) ^ (d < 0)))
272 t = lte;
274 /* now t should be close enough to the true UTC to yield the right answer */
275 return TimeDiff(t);
279 /****************************************************************************
280 try to optimise the localtime call, it can be quite expensive on some machines
281 ****************************************************************************/
282 struct tm *LocalTime(time_t *t)
284 time_t t2 = *t;
286 t2 -= TimeDiff(t2);
288 return(gmtime(&t2));
291 #define TIME_FIXUP_CONSTANT (369.0*365.25*24*60*60-(3.0*24*60*60+6.0*60*60))
293 /****************************************************************************
294 interpret an 8 byte "filetime" structure to a time_t
295 It's originally in "100ns units since jan 1st 1601"
297 It appears to be kludge-GMT (at least for file listings). This means
298 its the GMT you get by taking a localtime and adding the
299 serverzone. This is NOT the same as GMT in some cases. This routine
300 converts this to real GMT.
301 ****************************************************************************/
302 time_t nt_time_to_unix(NTTIME *nt)
304 double d;
305 time_t ret;
306 /* The next two lines are a fix needed for the
307 broken SCO compiler. JRA. */
308 time_t l_time_min = TIME_T_MIN;
309 time_t l_time_max = TIME_T_MAX;
311 if (nt->high == 0 || (nt->high == 0xffffffff && nt->low == 0xffffffff))
312 return(0);
314 d = ((double)nt->high)*4.0*(double)(1<<30);
315 d += (nt->low&0xFFF00000);
316 d *= 1.0e-7;
318 /* now adjust by 369 years to make the secs since 1970 */
319 d -= TIME_FIXUP_CONSTANT;
321 if (!(l_time_min <= d && d <= l_time_max))
322 return(0);
324 ret = (time_t)(d+0.5);
326 /* this takes us from kludge-GMT to real GMT */
327 ret -= get_serverzone();
328 ret += LocTimeDiff(ret);
330 return(ret);
333 /****************************************************************************
334 Convert a NTTIME structure to a time_t.
335 It's originally in "100ns units".
337 This is an absolute version of the one above.
338 By absolute I mean, it doesn't adjust from 1/1/1601 to 1/1/1970
339 if the NTTIME was 5 seconds, the time_t is 5 seconds. JFM
340 ****************************************************************************/
342 time_t nt_time_to_unix_abs(NTTIME *nt)
344 double d;
345 time_t ret;
346 /* The next two lines are a fix needed for the
347 broken SCO compiler. JRA. */
348 time_t l_time_min = TIME_T_MIN;
349 time_t l_time_max = TIME_T_MAX;
351 if (nt->high == 0)
352 return(0);
354 if (nt->high==0x80000000 && nt->low==0)
355 return -1;
357 /* reverse the time */
358 /* it's a negative value, turn it to positive */
359 nt->high=~nt->high;
360 nt->low=~nt->low;
362 d = ((double)nt->high)*4.0*(double)(1<<30);
363 d += (nt->low&0xFFF00000);
364 d *= 1.0e-7;
366 if (!(l_time_min <= d && d <= l_time_max))
367 return(0);
369 ret = (time_t)(d+0.5);
371 return(ret);
374 /****************************************************************************
375 interprets an nt time into a unix time_t
376 ****************************************************************************/
377 time_t interpret_long_date(char *p)
379 NTTIME nt;
380 nt.low = IVAL(p,0);
381 nt.high = IVAL(p,4);
382 return nt_time_to_unix(&nt);
385 /****************************************************************************
386 put a 8 byte filetime from a time_t
387 This takes real GMT as input and converts to kludge-GMT
388 ****************************************************************************/
389 void unix_to_nt_time(NTTIME *nt, time_t t)
391 double d;
393 if (t==0)
395 nt->low = 0;
396 nt->high = 0;
397 return;
399 if (t == TIME_T_MAX)
401 nt->low = 0xffffffff;
402 nt->high = 0x7fffffff;
403 return;
405 if (t == -1)
407 nt->low = 0xffffffff;
408 nt->high = 0xffffffff;
409 return;
412 /* this converts GMT to kludge-GMT */
413 t -= TimeDiff(t) - get_serverzone();
415 d = (double)(t);
416 d += TIME_FIXUP_CONSTANT;
417 d *= 1.0e7;
419 nt->high = (uint32)(d * (1.0/(4.0*(double)(1<<30))));
420 nt->low = (uint32)(d - ((double)nt->high)*4.0*(double)(1<<30));
423 /****************************************************************************
424 Convert a time_t to a NTTIME structure
426 This is an absolute version of the one above.
427 By absolute I mean, it doesn't adjust from 1/1/1970 to 1/1/1601
428 If the nttime_t was 5 seconds, the NTTIME is 5 seconds. JFM
429 ****************************************************************************/
431 void unix_to_nt_time_abs(NTTIME *nt, time_t t)
433 double d;
435 if (t==0) {
436 nt->low = 0;
437 nt->high = 0;
438 return;
441 if (t == TIME_T_MAX) {
442 nt->low = 0xffffffff;
443 nt->high = 0x7fffffff;
444 return;
447 if (t == -1) {
448 /* that's what NT uses for infinite */
449 nt->low = 0x0;
450 nt->high = 0x80000000;
451 return;
454 d = (double)(t);
455 d *= 1.0e7;
457 nt->high = (uint32)(d * (1.0/(4.0*(double)(1<<30))));
458 nt->low = (uint32)(d - ((double)nt->high)*4.0*(double)(1<<30));
460 /* convert to a negative value */
461 nt->high=~nt->high;
462 nt->low=~nt->low;
466 /****************************************************************************
467 take an NTTIME structure, containing high / low time. convert to unix time.
468 lkclXXXX this may need 2 SIVALs not a memcpy. we'll see...
469 ****************************************************************************/
470 void put_long_date(char *p,time_t t)
472 NTTIME nt;
473 unix_to_nt_time(&nt, t);
474 SIVAL(p, 0, nt.low);
475 SIVAL(p, 4, nt.high);
478 /****************************************************************************
479 check if it's a null mtime
480 ****************************************************************************/
481 BOOL null_mtime(time_t mtime)
483 if (mtime == 0 || mtime == (time_t)0xFFFFFFFF || mtime == (time_t)-1)
484 return(True);
485 return(False);
488 /*******************************************************************
489 create a 16 bit dos packed date
490 ********************************************************************/
491 static uint16 make_dos_date1(struct tm *t)
493 uint16 ret=0;
494 ret = (((unsigned)(t->tm_mon+1)) >> 3) | ((t->tm_year-80) << 1);
495 ret = ((ret&0xFF)<<8) | (t->tm_mday | (((t->tm_mon+1) & 0x7) << 5));
496 return(ret);
499 /*******************************************************************
500 create a 16 bit dos packed time
501 ********************************************************************/
502 static uint16 make_dos_time1(struct tm *t)
504 uint16 ret=0;
505 ret = ((((unsigned)t->tm_min >> 3)&0x7) | (((unsigned)t->tm_hour) << 3));
506 ret = ((ret&0xFF)<<8) | ((t->tm_sec/2) | ((t->tm_min & 0x7) << 5));
507 return(ret);
510 /*******************************************************************
511 create a 32 bit dos packed date/time from some parameters
512 This takes a GMT time and returns a packed localtime structure
513 ********************************************************************/
514 static uint32 make_dos_date(time_t unixdate)
516 struct tm *t;
517 uint32 ret=0;
519 t = LocalTime(&unixdate);
520 if (!t)
521 return 0xFFFFFFFF;
523 ret = make_dos_date1(t);
524 ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
526 return(ret);
529 /*******************************************************************
530 put a dos date into a buffer (time/date format)
531 This takes GMT time and puts local time in the buffer
532 ********************************************************************/
533 void put_dos_date(char *buf,int offset,time_t unixdate)
535 uint32 x = make_dos_date(unixdate);
536 SIVAL(buf,offset,x);
539 /*******************************************************************
540 put a dos date into a buffer (date/time format)
541 This takes GMT time and puts local time in the buffer
542 ********************************************************************/
543 void put_dos_date2(char *buf,int offset,time_t unixdate)
545 uint32 x = make_dos_date(unixdate);
546 x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
547 SIVAL(buf,offset,x);
550 /*******************************************************************
551 put a dos 32 bit "unix like" date into a buffer. This routine takes
552 GMT and converts it to LOCAL time before putting it (most SMBs assume
553 localtime for this sort of date)
554 ********************************************************************/
555 void put_dos_date3(char *buf,int offset,time_t unixdate)
557 if (!null_mtime(unixdate))
558 unixdate -= TimeDiff(unixdate);
559 SIVAL(buf,offset,unixdate);
562 /*******************************************************************
563 interpret a 32 bit dos packed date/time to some parameters
564 ********************************************************************/
565 static void interpret_dos_date(uint32 date,int *year,int *month,int *day,int *hour,int *minute,int *second)
567 uint32 p0,p1,p2,p3;
569 p0=date&0xFF; p1=((date&0xFF00)>>8)&0xFF;
570 p2=((date&0xFF0000)>>16)&0xFF; p3=((date&0xFF000000)>>24)&0xFF;
572 *second = 2*(p0 & 0x1F);
573 *minute = ((p0>>5)&0xFF) + ((p1&0x7)<<3);
574 *hour = (p1>>3)&0xFF;
575 *day = (p2&0x1F);
576 *month = ((p2>>5)&0xFF) + ((p3&0x1)<<3) - 1;
577 *year = ((p3>>1)&0xFF) + 80;
580 /*******************************************************************
581 create a unix date (int GMT) from a dos date (which is actually in
582 localtime)
583 ********************************************************************/
584 time_t make_unix_date(void *date_ptr)
586 uint32 dos_date=0;
587 struct tm t;
588 time_t ret;
590 dos_date = IVAL(date_ptr,0);
592 if (dos_date == 0) return(0);
594 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
595 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
596 t.tm_isdst = -1;
598 /* mktime() also does the local to GMT time conversion for us */
599 ret = mktime(&t);
601 return(ret);
604 /*******************************************************************
605 like make_unix_date() but the words are reversed
606 ********************************************************************/
607 time_t make_unix_date2(void *date_ptr)
609 uint32 x,x2;
611 x = IVAL(date_ptr,0);
612 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
613 SIVAL(&x,0,x2);
615 return(make_unix_date((void *)&x));
618 /*******************************************************************
619 create a unix GMT date from a dos date in 32 bit "unix like" format
620 these generally arrive as localtimes, with corresponding DST
621 ******************************************************************/
622 time_t make_unix_date3(void *date_ptr)
624 time_t t = (time_t)IVAL(date_ptr,0);
625 if (!null_mtime(t))
626 t += LocTimeDiff(t);
627 return(t);
631 /***************************************************************************
632 return a HTTP/1.0 time string
633 ***************************************************************************/
634 char *http_timestring(time_t t)
636 static fstring buf;
637 struct tm *tm = LocalTime(&t);
639 if (!tm)
640 slprintf(buf,sizeof(buf)-1,"%ld seconds since the Epoch",(long)t);
641 else
642 #ifndef HAVE_STRFTIME
643 fstrcpy(buf, asctime(tm));
644 if(buf[strlen(buf)-1] == '\n')
645 buf[strlen(buf)-1] = 0;
646 #else /* !HAVE_STRFTIME */
647 strftime(buf, sizeof(buf)-1, "%a, %d %b %Y %H:%M:%S %Z", tm);
648 #endif /* !HAVE_STRFTIME */
649 return buf;
654 /****************************************************************************
655 Return the date and time as a string
656 ****************************************************************************/
658 char *timestring(BOOL hires)
660 static fstring TimeBuf;
661 struct timeval tp;
662 time_t t;
663 struct tm *tm;
665 if (hires) {
666 GetTimeOfDay(&tp);
667 t = (time_t)tp.tv_sec;
668 } else {
669 t = time(NULL);
671 tm = LocalTime(&t);
672 if (!tm) {
673 if (hires) {
674 slprintf(TimeBuf,
675 sizeof(TimeBuf)-1,
676 "%ld.%06ld seconds since the Epoch",
677 (long)tp.tv_sec,
678 (long)tp.tv_usec);
679 } else {
680 slprintf(TimeBuf,
681 sizeof(TimeBuf)-1,
682 "%ld seconds since the Epoch",
683 (long)t);
685 } else {
686 #ifdef HAVE_STRFTIME
687 if (hires) {
688 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
689 slprintf(TimeBuf+strlen(TimeBuf),
690 sizeof(TimeBuf)-1 - strlen(TimeBuf),
691 ".%06ld",
692 (long)tp.tv_usec);
693 } else {
694 strftime(TimeBuf,100,"%Y/%m/%d %H:%M:%S",tm);
696 #else
697 if (hires) {
698 slprintf(TimeBuf,
699 sizeof(TimeBuf)-1,
700 "%s.%06ld",
701 asctime(tm),
702 (long)tp.tv_usec);
703 } else {
704 fstrcpy(TimeBuf, asctime(tm));
706 #endif
708 return(TimeBuf);
711 /****************************************************************************
712 return the best approximation to a 'create time' under UNIX from a stat
713 structure.
714 ****************************************************************************/
716 time_t get_create_time(SMB_STRUCT_STAT *st,BOOL fake_dirs)
718 time_t ret, ret1;
720 if(S_ISDIR(st->st_mode) && fake_dirs)
721 return (time_t)315493200L; /* 1/1/1980 */
723 ret = MIN(st->st_ctime, st->st_mtime);
724 ret1 = MIN(ret, st->st_atime);
726 if(ret1 != (time_t)0)
727 return ret1;
730 * One of ctime, mtime or atime was zero (probably atime).
731 * Just return MIN(ctime, mtime).
733 return ret;
736 /****************************************************************************
737 initialise an NTTIME to -1, which means "unknown" or "don't expire"
738 ****************************************************************************/
740 void init_nt_time(NTTIME *nt)
742 nt->high = 0x7FFFFFFF;
743 nt->low = 0xFFFFFFFF;
746 /****************************************************************************
747 check if NTTIME is 0
748 ****************************************************************************/
749 BOOL nt_time_is_zero(NTTIME *nt)
751 if(nt->high==0)
752 return True;
753 return False;