source3/lib/time.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    time handling functions
   5    Copyright (C) Andrew Tridgell 1992-1998
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23
  24 /*
  25   This stuff was largely rewritten by Paul Eggert <eggert@twinsun.com>
  26   in May 1996
  27   */
  28
  29
  30 int extra_time_offset = 0;
  31
  32 #ifndef CHAR_BIT
  33 #define CHAR_BIT 8
  34 #endif
  35
  36 #ifndef TIME_T_MIN
  37 #define TIME_T_MIN ((time_t)0 < (time_t) -1 ? (time_t) 0 \
  38                     : ~ (time_t) 0 << (sizeof (time_t) * CHAR_BIT - 1))
  39 #endif
  40 #ifndef TIME_T_MAX
  41 #define TIME_T_MAX (~ (time_t) 0 - TIME_T_MIN)
  42 #endif
  43
  44 /*******************************************************************
  45  External access to time_t_min and time_t_max.
  46 ********************************************************************/
  47
  48 time_t get_time_t_min(void)
  49 {
  50         return TIME_T_MIN;
  51 }
  52
  53 time_t get_time_t_max(void)
  54 {
  55         return TIME_T_MAX;
  56 }
  57
  58 /*******************************************************************
  59 a gettimeofday wrapper
  60 ********************************************************************/
  61 void GetTimeOfDay(struct timeval *tval)
  62 {
  63 #ifdef HAVE_GETTIMEOFDAY_TZ
  64         gettimeofday(tval,NULL);
  65 #else
  66         gettimeofday(tval);
  67 #endif
  68 }
  69
  70 #define TM_YEAR_BASE 1900
  71
  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)
  76 {
  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);
  86
  87   return seconds;
  88 }
  89
  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)
  94 {
  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);
 104
 105 }
 106
 107 static BOOL done_serverzone_init;
 108
 109 /* Return the smb serverzone value */
 110
 111 static int get_serverzone(void)
 112 {
 113         static int serverzone;
 114
 115         if (!done_serverzone_init) {
 116                 serverzone = TimeZone(time(NULL));
 117
 118                 if ((serverzone % 60) != 0) {
 119                         DEBUG(1,("WARNING: Your timezone is not a multiple of 1 minute.\n"));
 120                 }
 121
 122                 DEBUG(4,("Serverzone is %d\n",serverzone));
 123
 124                 done_serverzone_init = True;
 125         }
 126
 127         return serverzone;
 128 }
 129
 130 /* Re-read the smb serverzone value */
 131
 132 void TimeInit(void)
 133 {
 134         done_serverzone_init = False;
 135         get_serverzone();
 136 }
 137
 138 /*******************************************************************
 139 return the same value as TimeZone, but it should be more efficient.
 140
 141 We keep a table of DST offsets to prevent calling localtime() on each
 142 call of this function. This saves a LOT of time on many unixes.
 143
 144 Updated by Paul Eggert <eggert@twinsun.com>
 145 ********************************************************************/
 146 static int TimeZoneFaster(time_t t)
 147 {
 148   static struct dst_table {time_t start,end; int zone;} *tdt, *dst_table = NULL;
 149   static int table_size = 0;
 150   int i;
 151   int zone = 0;
 152
 153   if (t == 0) t = time(NULL);
 154
 155   /* Tunis has a 8 day DST region, we need to be careful ... */
 156 #define MAX_DST_WIDTH (365*24*60*60)
 157 #define MAX_DST_SKIP (7*24*60*60)
 158
 159   for (i=0;i<table_size;i++)
 160     if (t >= dst_table[i].start && t <= dst_table[i].end) break;
 161
 162   if (i<table_size) {
 163     zone = dst_table[i].zone;
 164   } else {
 165     time_t low,high;
 166
 167     zone = TimeZone(t);
 168     tdt = (struct dst_table *)Realloc(dst_table,
 169                                               sizeof(dst_table[0])*(i+1));
 170     if (!tdt) {
 171       DEBUG(0,("TimeZoneFaster: out of memory!\n"));
 172       SAFE_FREE(dst_table);
 173       table_size = 0;
 174     } else {
 175       dst_table = tdt;
 176       table_size++;
 177
 178       dst_table[i].zone = zone;
 179       dst_table[i].start = dst_table[i].end = t;
 180
 181       /* no entry will cover more than 6 months */
 182       low = t - MAX_DST_WIDTH/2;
 183       if (t < low)
 184         low = TIME_T_MIN;
 185
 186       high = t + MAX_DST_WIDTH/2;
 187       if (high < t)
 188         high = TIME_T_MAX;
 189
 190       /* widen the new entry using two bisection searches */
 191       while (low+60*60 < dst_table[i].start) {
 192         if (dst_table[i].start - low > MAX_DST_SKIP*2)
 193           t = dst_table[i].start - MAX_DST_SKIP;
 194         else
 195           t = low + (dst_table[i].start-low)/2;
 196         if (TimeZone(t) == zone)
 197           dst_table[i].start = t;
 198         else
 199           low = t;
 200       }
 201
 202       while (high-60*60 > dst_table[i].end) {
 203         if (high - dst_table[i].end > MAX_DST_SKIP*2)
 204           t = dst_table[i].end + MAX_DST_SKIP;
 205         else
 206           t = high - (high-dst_table[i].end)/2;
 207         if (TimeZone(t) == zone)
 208           dst_table[i].end = t;
 209         else
 210           high = t;
 211       }
 212 #if 0
 213       DEBUG(1,("Added DST entry from %s ",
 214                asctime(localtime(&dst_table[i].start))));
 215       DEBUG(1,("to %s (%d)\n",asctime(localtime(&dst_table[i].end)),
 216                dst_table[i].zone));
 217 #endif
 218     }
 219   }
 220   return zone;
 221 }
 222
 223 /****************************************************************************
 224   return the UTC offset in seconds west of UTC, adjusted for extra time offset
 225   **************************************************************************/
 226 int TimeDiff(time_t t)
 227 {
 228   return TimeZoneFaster(t) + 60*extra_time_offset;
 229 }
 230
 231
 232 /****************************************************************************
 233   return the UTC offset in seconds west of UTC, adjusted for extra time
 234   offset, for a local time value.  If ut = lt + LocTimeDiff(lt), then
 235   lt = ut - TimeDiff(ut), but the converse does not necessarily hold near
 236   daylight savings transitions because some local times are ambiguous.
 237   LocTimeDiff(t) equals TimeDiff(t) except near daylight savings transitions.
 238   +**************************************************************************/
 239 static int LocTimeDiff(time_t lte)
 240 {
 241   time_t lt = lte - 60*extra_time_offset;
 242   int d = TimeZoneFaster(lt);
 243   time_t t = lt + d;
 244
 245   /* if overflow occurred, ignore all the adjustments so far */
 246   if (((lte < lt) ^ (extra_time_offset < 0))  |  ((t < lt) ^ (d < 0)))
 247     t = lte;
 248
 249   /* now t should be close enough to the true UTC to yield the right answer */
 250   return TimeDiff(t);
 251 }
 252
 253
 254 /****************************************************************************
 255 try to optimise the localtime call, it can be quite expensive on some machines
 256 ****************************************************************************/
 257 struct tm *LocalTime(time_t *t)
 258 {
 259   time_t t2 = *t;
 260
 261   t2 -= TimeDiff(t2);
 262
 263   return(gmtime(&t2));
 264 }
 265
 266 #define TIME_FIXUP_CONSTANT (369.0*365.25*24*60*60-(3.0*24*60*60+6.0*60*60))
 267
 268 /****************************************************************************
 269 interpret an 8 byte "filetime" structure to a time_t
 270 It's originally in "100ns units since jan 1st 1601"
 271
 272 It appears to be kludge-GMT (at least for file listings). This means
 273 its the GMT you get by taking a localtime and adding the
 274 serverzone. This is NOT the same as GMT in some cases. This routine
 275 converts this to real GMT.
 276 ****************************************************************************/
 277 time_t nt_time_to_unix(NTTIME *nt)
 278 {
 279   double d;
 280   time_t ret;
 281   /* The next two lines are a fix needed for the
 282      broken SCO compiler. JRA. */
 283   time_t l_time_min = TIME_T_MIN;
 284   time_t l_time_max = TIME_T_MAX;
 285
 286   if (nt->high == 0) return(0);
 287
 288   d = ((double)nt->high)*4.0*(double)(1<<30);
 289   d += (nt->low&0xFFF00000);
 290   d *= 1.0e-7;
 291
 292   /* now adjust by 369 years to make the secs since 1970 */
 293   d -= TIME_FIXUP_CONSTANT;
 294
 295   if (!(l_time_min <= d && d <= l_time_max))
 296     return(0);
 297
 298   ret = (time_t)(d+0.5);
 299
 300   /* this takes us from kludge-GMT to real GMT */
 301   ret -= get_serverzone();
 302   ret += LocTimeDiff(ret);
 303
 304   return(ret);
 305 }
 306
 307
 308
 309 /****************************************************************************
 310 interprets an nt time into a unix time_t
 311 ****************************************************************************/
 312 time_t interpret_long_date(char *p)
 313 {
 314         NTTIME nt;
 315         nt.low = IVAL(p,0);
 316         nt.high = IVAL(p,4);
 317         return nt_time_to_unix(&nt);
 318 }
 319
 320 /****************************************************************************
 321 put a 8 byte filetime from a time_t
 322 This takes real GMT as input and converts to kludge-GMT
 323 ****************************************************************************/
 324 void unix_to_nt_time(NTTIME *nt, time_t t)
 325 {
 326         double d;
 327
 328         if (t==0)
 329         {
 330                 nt->low = 0;
 331                 nt->high = 0;
 332                 return;
 333         }
 334         if (t == TIME_T_MAX)
 335         {
 336                 nt->low = 0xffffffff;
 337                 nt->high = 0x7fffffff;
 338                 return;
 339         }
 340         if (t == -1)
 341         {
 342                 nt->low = 0xffffffff;
 343                 nt->high = 0xffffffff;
 344                 return;
 345         }
 346
 347         /* this converts GMT to kludge-GMT */
 348         t -= LocTimeDiff(t) - get_serverzone();
 349
 350         d = (double)(t);
 351         d += TIME_FIXUP_CONSTANT;
 352         d *= 1.0e7;
 353
 354         nt->high = (uint32)(d * (1.0/(4.0*(double)(1<<30))));
 355         nt->low  = (uint32)(d - ((double)nt->high)*4.0*(double)(1<<30));
 356 }
 357
 358
 359 /****************************************************************************
 360 take an NTTIME structure, containing high / low time.  convert to unix time.
 361 lkclXXXX this may need 2 SIVALs not a memcpy.  we'll see...
 362 ****************************************************************************/
 363 void put_long_date(char *p,time_t t)
 364 {
 365         NTTIME nt;
 366         unix_to_nt_time(&nt, t);
 367         SIVAL(p, 0, nt.low);
 368         SIVAL(p, 4, nt.high);
 369 }
 370
 371 /****************************************************************************
 372 check if it's a null mtime
 373 ****************************************************************************/
 374 BOOL null_mtime(time_t mtime)
 375 {
 376   if (mtime == 0 || mtime == 0xFFFFFFFF || mtime == (time_t)-1)
 377     return(True);
 378   return(False);
 379 }
 380
 381 /*******************************************************************
 382   create a 16 bit dos packed date
 383 ********************************************************************/
 384 static uint16 make_dos_date1(struct tm *t)
 385 {
 386   uint16 ret=0;
 387   ret = (((unsigned)(t->tm_mon+1)) >> 3) | ((t->tm_year-80) << 1);
 388   ret = ((ret&0xFF)<<8) | (t->tm_mday | (((t->tm_mon+1) & 0x7) << 5));
 389   return(ret);
 390 }
 391
 392 /*******************************************************************
 393   create a 16 bit dos packed time
 394 ********************************************************************/
 395 static uint16 make_dos_time1(struct tm *t)
 396 {
 397   uint16 ret=0;
 398   ret = ((((unsigned)t->tm_min >> 3)&0x7) | (((unsigned)t->tm_hour) << 3));
 399   ret = ((ret&0xFF)<<8) | ((t->tm_sec/2) | ((t->tm_min & 0x7) << 5));
 400   return(ret);
 401 }
 402
 403 /*******************************************************************
 404   create a 32 bit dos packed date/time from some parameters
 405   This takes a GMT time and returns a packed localtime structure
 406 ********************************************************************/
 407 static uint32 make_dos_date(time_t unixdate)
 408 {
 409   struct tm *t;
 410   uint32 ret=0;
 411
 412   t = LocalTime(&unixdate);
 413   if (!t)
 414     return 0xFFFFFFFF;
 415
 416   ret = make_dos_date1(t);
 417   ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
 418
 419   return(ret);
 420 }
 421
 422 /*******************************************************************
 423 put a dos date into a buffer (time/date format)
 424 This takes GMT time and puts local time in the buffer
 425 ********************************************************************/
 426 void put_dos_date(char *buf,int offset,time_t unixdate)
 427 {
 428   uint32 x = make_dos_date(unixdate);
 429   SIVAL(buf,offset,x);
 430 }
 431
 432 /*******************************************************************
 433 put a dos date into a buffer (date/time format)
 434 This takes GMT time and puts local time in the buffer
 435 ********************************************************************/
 436 void put_dos_date2(char *buf,int offset,time_t unixdate)
 437 {
 438   uint32 x = make_dos_date(unixdate);
 439   x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
 440   SIVAL(buf,offset,x);
 441 }
 442
 443 /*******************************************************************
 444 put a dos 32 bit "unix like" date into a buffer. This routine takes
 445 GMT and converts it to LOCAL time before putting it (most SMBs assume
 446 localtime for this sort of date)
 447 ********************************************************************/
 448 void put_dos_date3(char *buf,int offset,time_t unixdate)
 449 {
 450   if (!null_mtime(unixdate))
 451     unixdate -= TimeDiff(unixdate);
 452   SIVAL(buf,offset,unixdate);
 453 }
 454
 455 /*******************************************************************
 456   interpret a 32 bit dos packed date/time to some parameters
 457 ********************************************************************/
 458 static void interpret_dos_date(uint32 date,int *year,int *month,int *day,int *hour,int *minute,int *second)
 459 {
 460   uint32 p0,p1,p2,p3;
 461
 462   p0=date&0xFF; p1=((date&0xFF00)>>8)&0xFF;
 463   p2=((date&0xFF0000)>>16)&0xFF; p3=((date&0xFF000000)>>24)&0xFF;
 464
 465   *second = 2*(p0 & 0x1F);
 466   *minute = ((p0>>5)&0xFF) + ((p1&0x7)<<3);
 467   *hour = (p1>>3)&0xFF;
 468   *day = (p2&0x1F);
 469   *month = ((p2>>5)&0xFF) + ((p3&0x1)<<3) - 1;
 470   *year = ((p3>>1)&0xFF) + 80;
 471 }
 472
 473 /*******************************************************************
 474   create a unix date (int GMT) from a dos date (which is actually in
 475   localtime)
 476 ********************************************************************/
 477 time_t make_unix_date(void *date_ptr)
 478 {
 479   uint32 dos_date=0;
 480   struct tm t;
 481   time_t ret;
 482
 483   dos_date = IVAL(date_ptr,0);
 484
 485   if (dos_date == 0) return(0);
 486
 487   interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
 488                      &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
 489   t.tm_isdst = -1;
 490
 491   /* mktime() also does the local to GMT time conversion for us */
 492   ret = mktime(&t);
 493
 494   return(ret);
 495 }
 496
 497 /*******************************************************************
 498 like make_unix_date() but the words are reversed
 499 ********************************************************************/
 500 time_t make_unix_date2(void *date_ptr)
 501 {
 502   uint32 x,x2;
 503
 504   x = IVAL(date_ptr,0);
 505   x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
 506   SIVAL(&x,0,x2);
 507
 508   return(make_unix_date((void *)&x));
 509 }
 510
 511 /*******************************************************************
 512   create a unix GMT date from a dos date in 32 bit "unix like" format
 513   these generally arrive as localtimes, with corresponding DST
 514   ******************************************************************/
 515 time_t make_unix_date3(void *date_ptr)
 516 {
 517   time_t t = (time_t)IVAL(date_ptr,0);
 518   if (!null_mtime(t))
 519     t += LocTimeDiff(t);
 520   return(t);
 521 }
 522
 523
 524 /***************************************************************************
 525 return a HTTP/1.0 time string
 526   ***************************************************************************/
 527 char *http_timestring(time_t t)
 528 {
 529   static fstring buf;
 530   struct tm *tm = LocalTime(&t);
 531
 532   if (!tm)
 533     slprintf(buf,sizeof(buf)-1,"%ld seconds since the Epoch",(long)t);
 534   else
 535 #ifndef HAVE_STRFTIME
 536   fstrcpy(buf, asctime(tm));
 537   if(buf[strlen(buf)-1] == '\n')
 538     buf[strlen(buf)-1] = 0;
 539 #else /* !HAVE_STRFTIME */
 540   strftime(buf, sizeof(buf)-1, "%a, %d %b %Y %H:%M:%S %Z", tm);
 541 #endif /* !HAVE_STRFTIME */
 542   return buf;
 543 }
 544
 545
 546
 547 /****************************************************************************
 548  Return the date and time as a string
 549 ****************************************************************************/
 550
 551 char *timestring(BOOL hires)
 552 {
 553         static fstring TimeBuf;
 554         struct timeval tp;
 555         time_t t;
 556         struct tm *tm;
 557
 558         if (hires) {
 559                 GetTimeOfDay(&tp);
 560                 t = (time_t)tp.tv_sec;
 561         } else {
 562                 t = time(NULL);
 563         }
 564         tm = LocalTime(&t);
 565         if (!tm) {
 566                 if (hires) {
 567                         slprintf(TimeBuf,
 568                                  sizeof(TimeBuf)-1,
 569                                  "%ld.%06ld seconds since the Epoch",
 570                                  (long)tp.tv_sec,
 571                                  (long)tp.tv_usec);
 572                 } else {
 573                         slprintf(TimeBuf,
 574                                  sizeof(TimeBuf)-1,
 575                                  "%ld seconds since the Epoch",
 576                                  (long)t);
 577                 }
 578         } else {
 579 #ifdef HAVE_STRFTIME
 580                 if (hires) {
 581                         strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
 582                         slprintf(TimeBuf+strlen(TimeBuf),
 583                                  sizeof(TimeBuf)-1 - strlen(TimeBuf),
 584                                  ".%06ld",
 585                                  (long)tp.tv_usec);
 586                 } else {
 587                         strftime(TimeBuf,100,"%Y/%m/%d %H:%M:%S",tm);
 588                 }
 589 #else
 590                 if (hires) {
 591                         slprintf(TimeBuf,
 592                                  sizeof(TimeBuf)-1,
 593                                  "%s.%06ld",
 594                                  asctime(tm),
 595                                  (long)tp.tv_usec);
 596                 } else {
 597                         fstrcpy(TimeBuf, asctime(tm));
 598                 }
 599 #endif
 600         }
 601         return(TimeBuf);
 602 }
 603
 604 /****************************************************************************
 605   return the best approximation to a 'create time' under UNIX from a stat
 606   structure.
 607 ****************************************************************************/
 608
 609 time_t get_create_time(SMB_STRUCT_STAT *st,BOOL fake_dirs)
 610 {
 611   time_t ret, ret1;
 612
 613   if(S_ISDIR(st->st_mode) && fake_dirs)
 614     return (time_t)315493200L;          /* 1/1/1980 */
 615
 616   ret = MIN(st->st_ctime, st->st_mtime);
 617   ret1 = MIN(ret, st->st_atime);
 618
 619   if(ret1 != (time_t)0)
 620     return ret1;
 621
 622   /*
 623    * One of ctime, mtime or atime was zero (probably atime).
 624    * Just return MIN(ctime, mtime).
 625    */
 626   return ret;
 627 }
 628
 629 /****************************************************************************
 630 initialise an NTTIME to -1, which means "unknown" or "don't expire"
 631 ****************************************************************************/
 632
 633 void init_nt_time(NTTIME *nt)
 634 {
 635         nt->high = 0x7FFFFFFF;
 636         nt->low = 0xFFFFFFFF;
 637 }