git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/btime.c

   1 /*
   2  * Bacula time and date routines -- John Walker
   3  *
   4  *   Version $Id$
   5  */
   6 /*
   7    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
   8
   9    This program is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU General Public License as
  11    published by the Free Software Foundation; either version 2 of
  12    the License, or (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17    General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public
  20    License along with this program; if not, write to the Free
  21    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  22    MA 02111-1307, USA.
  23
  24  */
  25
  26
  27 /* Concerning times. There are a number of differnt time standards
  28  * in Bacula (fdate_t, ftime_t, time_t (Unix standard), btime_t, and
  29  *  utime_t).  fdate_t and ftime_t are deprecated and should no longer
  30  *  be used, and in general, Unix time time_t should no longer be used,
  31  *  it is being phased out.
  32  *
  33  *  Epoch is the base of Unix time (time_t, ...) and is 1 Jan 1970 at 0:0
  34  *
  35  *  The major two times that should be left are:
  36  *     btime_t  (64 bit integer in microseconds base Epoch)
  37  *     utime_t  (64 bit integer in seconds base Epoch)
  38  */
  39
  40 #include "bacula.h"
  41 #include <math.h>
  42
  43 void bstrftime(char *dt, int maxlen, utime_t tim)
  44 {
  45    time_t ttime = tim;
  46    struct tm tm;
  47
  48    /* ***FIXME**** the format and localtime_r() should be user configurable */
  49    localtime_r(&ttime, &tm);
  50    strftime(dt, maxlen, "%d-%b-%Y %H:%M", &tm);
  51 }
  52
  53 utime_t str_to_utime(char *str)
  54 {
  55    struct tm tm;
  56
  57    if (sscanf(str, "%d-%d-%d %d:%d:%d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
  58                                         &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
  59       return -1;
  60    }
  61    tm.tm_mon--;
  62    tm.tm_year -= 1900;
  63    return (utime_t)mktime(&tm);
  64 }
  65
  66 void get_current_time(struct date_time *dt)
  67 {
  68    struct tm tm;
  69    time_t now;
  70
  71    now = time(NULL);
  72    gmtime_r(&now, &tm);
  73    Dmsg6(200, "m=%d d=%d y=%d h=%d m=%d s=%d\n", tm.tm_mon+1, tm.tm_mday, tm.tm_year+1900,
  74       tm.tm_hour, tm.tm_min, tm.tm_sec);
  75    tm_encode(dt, &tm);
  76 #ifdef DEBUG
  77    Dmsg2(200, "jday=%f jmin=%f\n", dt->julian_day_number, dt->julian_day_fraction);
  78    tm_decode(dt, &tm);
  79    Dmsg6(200, "m=%d d=%d y=%d h=%d m=%d s=%d\n", tm.tm_mon+1, tm.tm_mday, tm.tm_year+1900,
  80       tm.tm_hour, tm.tm_min, tm.tm_sec);
  81 #endif
  82 }
  83
  84 /*
  85  * Bacula's time (btime_t) is an unsigned 64 bit integer that contains
  86  *   the number of microseconds since Epoch Time (1 Jan 1970).
  87  */
  88
  89 btime_t get_current_btime()
  90 {
  91    struct timeval tv;
  92    if (gettimeofday(&tv, NULL) != 0) {
  93       tv.tv_sec = (long)time(NULL);   /* fall back to old method */
  94       tv.tv_usec = 0;
  95    }
  96    return ((btime_t)tv.tv_sec) * 1000000 + (btime_t)tv.tv_usec;
  97 }
  98
  99 /* Convert btime to Unix time */
 100 time_t btime_to_unix(btime_t bt)
 101 {
 102    return (time_t)(bt/1000000);
 103 }
 104
 105 /* Convert btime to utime */
 106 utime_t btime_to_utime(btime_t bt)
 107 {
 108    return (utime_t)bt;
 109 }
 110
 111
 112
 113 /*  date_encode  --  Encode civil date as a Julian day number.  */
 114
 115 fdate_t date_encode(uint32_t year, uint8_t month, uint8_t day)
 116 {
 117
 118     /* Algorithm as given in Meeus, Astronomical Algorithms, Chapter 7, page 61 */
 119
 120     int32_t a, b, m;
 121     uint32_t y;
 122
 123     ASSERT(month < 13);
 124     ASSERT(day > 0 && day < 32);
 125
 126     m = month;
 127     y = year;
 128
 129     if (m <= 2) {
 130         y--;
 131         m += 12;
 132     }
 133
 134     /* Determine whether date is in Julian or Gregorian calendar based on
 135        canonical date of calendar reform. */
 136
 137     if ((year < 1582) || ((year == 1582) && ((month < 9) || (month == 9 && day < 5)))) {
 138         b = 0;
 139     } else {
 140         a = ((int) (y / 100));
 141         b = 2 - a + (a / 4);
 142     }
 143
 144     return (((int32_t) (365.25 * (y + 4716))) + ((int) (30.6001 * (m + 1))) +
 145                 day + b - 1524.5);
 146 }
 147
 148 /*  time_encode  --  Encode time from hours, minutes, and seconds
 149                      into a fraction of a day.  */
 150
 151 ftime_t time_encode(uint8_t hour, uint8_t minute, uint8_t second,
 152                    float32_t second_fraction)
 153 {
 154     ASSERT((second_fraction >= 0.0) || (second_fraction < 1.0));
 155     return (ftime_t) (((second + 60L * (minute + 60L * hour)) / 86400.0)) +
 156                      second_fraction;
 157 }
 158
 159 /*  date_time_encode  --  Set day number and fraction from date
 160                           and time.  */
 161
 162 void date_time_encode(struct date_time *dt,
 163                       uint32_t year, uint8_t month, uint8_t day,
 164                       uint8_t hour, uint8_t minute, uint8_t second,
 165                       float32_t second_fraction)
 166 {
 167     dt->julian_day_number = date_encode(year, month, day);
 168     dt->julian_day_fraction = time_encode(hour, minute, second, second_fraction);
 169 }
 170
 171 /*  date_decode  --  Decode a Julian day number into civil date.  */
 172
 173 void date_decode(fdate_t date, uint32_t *year, uint8_t *month,
 174                  uint8_t *day)
 175 {
 176     fdate_t z, f, a, alpha, b, c, d, e;
 177
 178     date += 0.5;
 179     z = floor(date);
 180     f = date - z;
 181
 182     if (z < 2299161.0) {
 183         a = z;
 184     } else {
 185         alpha = floor((z - 1867216.25) / 36524.25);
 186         a = z + 1 + alpha - floor(alpha / 4);
 187     }
 188
 189     b = a + 1524;
 190     c = floor((b - 122.1) / 365.25);
 191     d = floor(365.25 * c);
 192     e = floor((b - d) / 30.6001);
 193
 194     *day = (uint8_t) (b - d - floor(30.6001 * e) + f);
 195     *month = (uint8_t) ((e < 14) ? (e - 1) : (e - 13));
 196     *year = (uint32_t) ((*month > 2) ? (c - 4716) : (c - 4715));
 197 }
 198
 199 /*  time_decode  --  Decode a day fraction into civil time.  */
 200
 201 void time_decode(ftime_t time, uint8_t *hour, uint8_t *minute,
 202                  uint8_t *second, float32_t *second_fraction)
 203 {
 204     uint32_t ij;
 205
 206     ij = (uint32_t) ((time - floor(time)) * 86400.0);
 207     *hour = (uint8_t) (ij / 3600L);
 208     *minute = (uint8_t) ((ij / 60L) % 60L);
 209     *second = (uint8_t) (ij % 60L);
 210     if (second_fraction != NULL) {
 211         *second_fraction = time - floor(time);
 212     }
 213 }
 214
 215 /*  date_time_decode  --  Decode a Julian day and day fraction
 216                           into civil date and time.  */
 217
 218 void date_time_decode(struct date_time *dt,
 219                       uint32_t *year, uint8_t *month, uint8_t *day,
 220                       uint8_t *hour, uint8_t *minute, uint8_t *second,
 221                       float32_t *second_fraction)
 222 {
 223     date_decode(dt->julian_day_number, year, month, day);
 224     time_decode(dt->julian_day_fraction, hour, minute, second, second_fraction);
 225 }
 226
 227 /*  tm_encode  --  Encode a civil date and time from a tm structure
 228  *                 to a Julian day and day fraction.
 229  */
 230
 231 void tm_encode(struct date_time *dt,
 232                       struct tm *tm)
 233 {
 234     uint32_t year;
 235     uint8_t month, day, hour, minute, second;
 236
 237     year = tm->tm_year + 1900;
 238     month = tm->tm_mon + 1;
 239     day = tm->tm_mday;
 240     hour = tm->tm_hour;
 241     minute = tm->tm_min;
 242     second = tm->tm_sec;
 243     dt->julian_day_number = date_encode(year, month, day);
 244     dt->julian_day_fraction = time_encode(hour, minute, second, 0.0);
 245 }
 246
 247
 248 /*  tm_decode  --  Decode a Julian day and day fraction
 249                    into civil date and time in tm structure */
 250
 251 void tm_decode(struct date_time *dt,
 252                       struct tm *tm)
 253 {
 254     uint32_t year;
 255     uint8_t month, day, hour, minute, second;
 256
 257     date_decode(dt->julian_day_number, &year, &month, &day);
 258     time_decode(dt->julian_day_fraction, &hour, &minute, &second, NULL);
 259     tm->tm_year = year - 1900;
 260     tm->tm_mon = month - 1;
 261     tm->tm_mday = day;
 262     tm->tm_hour = hour;
 263     tm->tm_min = minute;
 264     tm->tm_sec = second;
 265 }
 266
 267
 268 /*  date_time_compare  --  Compare two dates and times and return
 269                            the relationship as follows:
 270
 271                                     -1    dt1 < dt2
 272                                      0    dt1 = dt2
 273                                      1    dt1 > dt2
 274 */
 275
 276 int date_time_compare(struct date_time *dt1, struct date_time *dt2)
 277 {
 278     if (dt1->julian_day_number == dt2->julian_day_number) {
 279         if (dt1->julian_day_fraction == dt2->julian_day_fraction) {
 280             return 0;
 281         }
 282         return (dt1->julian_day_fraction < dt2->julian_day_fraction) ? -1 : 1;
 283     }
 284     return (dt1->julian_day_number - dt2->julian_day_number) ? -1 : 1;
 285 }