2 * Bacula time and date routines -- John Walker
7 Copyright (C) 2000-2003 Kern Sibbald and John Walker
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.
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.
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,
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.
33 * Epoch is the base of Unix time in seconds (time_t, ...)
34 * and is 1 Jan 1970 at 0:0 UTC
36 * The major two times that should be left are:
37 * btime_t (64 bit integer in microseconds base Epoch)
38 * utime_t (64 bit integer in seconds base Epoch)
44 /* Formatted time for user display: dd-Mon-yyyy hh:mm */
45 char *bstrftime(char *dt, int maxlen, utime_t tim)
50 /* ***FIXME**** the format and localtime_r() should be user configurable */
51 localtime_r(&ttime, &tm);
52 strftime(dt, maxlen, "%d-%b-%Y %H:%M", &tm);
56 /* Formatted time for user display: dd-Mon-yy hh:mm (no century) */
57 char *bstrftime_nc(char *dt, int maxlen, utime_t tim)
62 /* ***FIXME**** the format and localtime_r() should be user configurable */
63 localtime_r(&ttime, &tm);
64 /* NOTE! since the compiler complains about %y, I use %y and cut the century */
65 strftime(dt, maxlen, "%d-%b-%Y %H:%M", &tm);
71 /* Unix time to standard time string yyyy-mm-dd hh:mm:ss */
72 char *bstrutime(char *dt, int maxlen, utime_t tim)
76 localtime_r(&ttime, &tm);
77 strftime(dt, maxlen, "%Y-%m-%d %H:%M:%S", &tm);
81 /* Convert standard time string yyyy-mm-dd hh:mm:ss to Unix time */
82 utime_t str_to_utime(char *str)
87 if (sscanf(str, "%d-%d-%d %d:%d:%d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
88 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
96 if (tm.tm_year >= 1900) {
101 tm.tm_wday = tm.tm_yday = 0;
107 return (utime_t)ttime;
112 * Bacula's time (btime_t) is an unsigned 64 bit integer that contains
113 * the number of microseconds since Epoch Time (1 Jan 1970) UTC.
116 btime_t get_current_btime()
119 if (gettimeofday(&tv, NULL) != 0) {
120 tv.tv_sec = (long)time(NULL); /* fall back to old method */
123 return ((btime_t)tv.tv_sec) * 1000000 + (btime_t)tv.tv_usec;
126 /* Convert btime to Unix time */
127 time_t btime_to_unix(btime_t bt)
129 return (time_t)(bt/1000000);
132 /* Convert btime to utime */
133 utime_t btime_to_utime(btime_t bt)
135 return (utime_t)(bt/1000000);
139 * Return the week of the month, base 0 (wpos)
140 * given tm_mday and tm_wday. Value returned
141 * can be from 0 to 4 => week1, ... week5
143 int tm_wom(int mday, int wday)
145 int fs; /* first sunday */
146 fs = (mday%7) - wday;
151 // Dmsg2(100, "wom=0 wday=%d <= fs=%d\n", wday, fs);
154 int wom = 1 + (mday - fs - 1) / 7;
155 // Dmsg3(100, "wom=%d wday=%d fs=%d\n", wom, wday, fs);
160 * Given a Unix date return the week of the year.
161 * The returned value can be 0-53. Officially
162 * the weeks are numbered from 1 to 53 where week1
163 * is the week in which the first Thursday of the
164 * year occurs (alternatively, the week which contains
165 * the 4th of January). We return 0, if the week of the
166 * year does not fall in the current year.
168 int tm_woy(time_t stime)
170 int woy, fty, tm_yday;
173 memset(&tm, 0, sizeof(struct tm));
174 localtime_r(&stime, &tm);
175 tm_yday = tm.tm_yday;
179 localtime_r(&time4, &tm);
180 fty = 1 - tm.tm_wday;
184 woy = tm_yday - fty + 4;
191 /* Deprecated. Do not use. */
192 void get_current_time(struct date_time *dt)
199 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,
200 tm.tm_hour, tm.tm_min, tm.tm_sec);
203 Dmsg2(200, "jday=%f jmin=%f\n", dt->julian_day_number, dt->julian_day_fraction);
205 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,
206 tm.tm_hour, tm.tm_min, tm.tm_sec);
211 /* date_encode -- Encode civil date as a Julian day number. */
213 /* Deprecated. Do not use. */
214 fdate_t date_encode(uint32_t year, uint8_t month, uint8_t day)
217 /* Algorithm as given in Meeus, Astronomical Algorithms, Chapter 7, page 61 */
223 ASSERT(day > 0 && day < 32);
233 /* Determine whether date is in Julian or Gregorian calendar based on
234 canonical date of calendar reform. */
236 if ((year < 1582) || ((year == 1582) && ((month < 9) || (month == 9 && day < 5)))) {
239 a = ((int) (y / 100));
243 return (((int32_t) (365.25 * (y + 4716))) + ((int) (30.6001 * (m + 1))) +
247 /* time_encode -- Encode time from hours, minutes, and seconds
248 into a fraction of a day. */
250 /* Deprecated. Do not use. */
251 ftime_t time_encode(uint8_t hour, uint8_t minute, uint8_t second,
252 float32_t second_fraction)
254 ASSERT((second_fraction >= 0.0) || (second_fraction < 1.0));
255 return (ftime_t) (((second + 60L * (minute + 60L * hour)) / 86400.0)) +
259 /* date_time_encode -- Set day number and fraction from date
262 /* Deprecated. Do not use. */
263 void date_time_encode(struct date_time *dt,
264 uint32_t year, uint8_t month, uint8_t day,
265 uint8_t hour, uint8_t minute, uint8_t second,
266 float32_t second_fraction)
268 dt->julian_day_number = date_encode(year, month, day);
269 dt->julian_day_fraction = time_encode(hour, minute, second, second_fraction);
272 /* date_decode -- Decode a Julian day number into civil date. */
274 /* Deprecated. Do not use. */
275 void date_decode(fdate_t date, uint32_t *year, uint8_t *month,
278 fdate_t z, f, a, alpha, b, c, d, e;
287 alpha = floor((z - 1867216.25) / 36524.25);
288 a = z + 1 + alpha - floor(alpha / 4);
292 c = floor((b - 122.1) / 365.25);
293 d = floor(365.25 * c);
294 e = floor((b - d) / 30.6001);
296 *day = (uint8_t) (b - d - floor(30.6001 * e) + f);
297 *month = (uint8_t) ((e < 14) ? (e - 1) : (e - 13));
298 *year = (uint32_t) ((*month > 2) ? (c - 4716) : (c - 4715));
301 /* time_decode -- Decode a day fraction into civil time. */
303 /* Deprecated. Do not use. */
304 void time_decode(ftime_t time, uint8_t *hour, uint8_t *minute,
305 uint8_t *second, float32_t *second_fraction)
309 ij = (uint32_t) ((time - floor(time)) * 86400.0);
310 *hour = (uint8_t) (ij / 3600L);
311 *minute = (uint8_t) ((ij / 60L) % 60L);
312 *second = (uint8_t) (ij % 60L);
313 if (second_fraction != NULL) {
314 *second_fraction = time - floor(time);
318 /* date_time_decode -- Decode a Julian day and day fraction
319 into civil date and time. */
321 /* Deprecated. Do not use. */
322 void date_time_decode(struct date_time *dt,
323 uint32_t *year, uint8_t *month, uint8_t *day,
324 uint8_t *hour, uint8_t *minute, uint8_t *second,
325 float32_t *second_fraction)
327 date_decode(dt->julian_day_number, year, month, day);
328 time_decode(dt->julian_day_fraction, hour, minute, second, second_fraction);
331 /* tm_encode -- Encode a civil date and time from a tm structure
332 * to a Julian day and day fraction.
335 /* Deprecated. Do not use. */
336 void tm_encode(struct date_time *dt,
340 uint8_t month, day, hour, minute, second;
342 year = tm->tm_year + 1900;
343 month = tm->tm_mon + 1;
348 dt->julian_day_number = date_encode(year, month, day);
349 dt->julian_day_fraction = time_encode(hour, minute, second, 0.0);
353 /* tm_decode -- Decode a Julian day and day fraction
354 into civil date and time in tm structure */
356 /* Deprecated. Do not use. */
357 void tm_decode(struct date_time *dt,
361 uint8_t month, day, hour, minute, second;
363 date_decode(dt->julian_day_number, &year, &month, &day);
364 time_decode(dt->julian_day_fraction, &hour, &minute, &second, NULL);
365 tm->tm_year = year - 1900;
366 tm->tm_mon = month - 1;
374 /* date_time_compare -- Compare two dates and times and return
375 the relationship as follows:
382 /* Deprecated. Do not use. */
383 int date_time_compare(struct date_time *dt1, struct date_time *dt2)
385 if (dt1->julian_day_number == dt2->julian_day_number) {
386 if (dt1->julian_day_fraction == dt2->julian_day_fraction) {
389 return (dt1->julian_day_fraction < dt2->julian_day_fraction) ? -1 : 1;
391 return (dt1->julian_day_number - dt2->julian_day_number) ? -1 : 1;