]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/lib/btime.c
Merge branch 'master' into basejobv3
[bacula/bacula] / bacula / src / lib / btime.c
index 825573e2cf37fd853282ad35d90fd61b4927626f..2901b27b11e035e3c0c160f2dc793deaac349496 100644 (file)
@@ -1,26 +1,36 @@
 /*
- * Bacula time and date routines -- John Walker
- *
- *   Version $Id$
- */
-/*
-   Copyright (C) 2000-2003 Kern Sibbald and John Walker
+   Bacula® - The Network Backup Solution
+
+   Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of
-   the License, or (at your option) any later version.
+   The main author of Bacula is Kern Sibbald, with contributions from
+   many others, a complete list can be found in the file AUTHORS.
+   This program is Free Software; you can redistribute it and/or
+   modify it under the terms of version two of the GNU General Public
+   License as published by the Free Software Foundation and included
+   in the file LICENSE.
 
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    General Public License for more details.
 
-   You should have received a copy of the GNU General Public
-   License along with this program; if not, write to the Free
-   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-   MA 02111-1307, USA.
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
+   Bacula® is a registered trademark of Kern Sibbald.
+   The licensor of Bacula is the Free Software Foundation Europe
+   (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+   Switzerland, email:ftf@fsfeurope.org.
+*/
+/*
+ * Bacula floating point time and date routines -- John Walker
+ *
+ * Later double precision integer time/date routines -- Kern Sibbald
+ *
+ *   Version $Id$
  */
 
 
  * in Bacula (fdate_t, ftime_t, time_t (Unix standard), btime_t, and
  *  utime_t).  fdate_t and ftime_t are deprecated and should no longer
  *  be used, and in general, Unix time time_t should no longer be used,
- *  it is being phased out. 
- *     
- *  Epoch is the base of Unix time in seconds (time_t, ...) 
+ *  it is being phased out.
+ *
+ *  Epoch is the base of Unix time in seconds (time_t, ...)
  *     and is 1 Jan 1970 at 0:0 UTC
  *
  *  The major two times that should be left are:
- *     btime_t (64 bit integer in microseconds base Epoch)
- *     utime_t (64 bit integer in seconds base Epoch)
+ *     btime_t  (64 bit integer in microseconds base Epoch)
+ *     utime_t  (64 bit integer in seconds base Epoch)
  */
 
 #include "bacula.h"
 #include <math.h>
 
 /* Formatted time for user display: dd-Mon-yyyy hh:mm */
-char *bstrftime(char *dt, int maxlen, utime_t tim)
+char *bstrftime(char *dt, int maxlen, utime_t utime)
 {
-   time_t ttime = tim;
+   time_t time = (time_t)utime;
    struct tm tm;
-   
+
    /* ***FIXME**** the format and localtime_r() should be user configurable */
-   localtime_r(&ttime, &tm);
+   (void)localtime_r(&time, &tm);
    strftime(dt, maxlen, "%d-%b-%Y %H:%M", &tm);
    return dt;
 }
 
+/* Formatted time for user display: dd-Mon-yyyy hh:mm:ss */
+char *bstrftimes(char *dt, int maxlen, utime_t utime)
+{
+   time_t time = (time_t)utime;
+   struct tm tm;
+
+   /* ***FIXME**** the format and localtime_r() should be user configurable */
+   (void)localtime_r(&time, &tm);
+   strftime(dt, maxlen, "%d-%b-%Y %H:%M:%S", &tm);
+   return dt;
+}
+
+
+/* Formatted time for user display: dd-Mon hh:mm */
+char *bstrftime_ny(char *dt, int maxlen, utime_t utime)
+{
+   time_t time = (time_t)utime;
+   struct tm tm;
+
+   /* ***FIXME**** the format and localtime_r() should be user configurable */
+   (void)localtime_r(&time, &tm);
+   strftime(dt, maxlen, "%d-%b %H:%M", &tm);
+   return dt;
+}
+
+
 /* Formatted time for user display: dd-Mon-yy hh:mm  (no century) */
-char *bstrftime_nc(char *dt, int maxlen, utime_t tim)
+char *bstrftime_nc(char *dt, int maxlen, utime_t utime)
 {
-   time_t ttime = tim;
+   time_t time = (time_t)utime;
    struct tm tm;
-   
+   char *p, *q;
+
    /* ***FIXME**** the format and localtime_r() should be user configurable */
-   localtime_r(&ttime, &tm);
+   (void)localtime_r(&time, &tm);
    /* NOTE! since the compiler complains about %y, I use %y and cut the century */
    strftime(dt, maxlen, "%d-%b-%Y %H:%M", &tm);
-   strcpy(dt+7, dt+9);
+   /* overlay the century */
+   p = dt+7;
+   q = dt+9;
+   while (*q) {
+      *p++ = *q++;
+   }
+   *p = 0;
    return dt;
 }
 
 
 /* Unix time to standard time string yyyy-mm-dd hh:mm:ss */
-char *bstrutime(char *dt, int maxlen, utime_t tim)
+char *bstrutime(char *dt, int maxlen, utime_t utime)
 {
-   time_t ttime = tim;
+   time_t time = (time_t)utime;
    struct tm tm;
-   localtime_r(&ttime, &tm);
+   (void)localtime_r(&time, &tm);
    strftime(dt, maxlen, "%Y-%m-%d %H:%M:%S", &tm);
    return dt;
 }
 
 /* Convert standard time string yyyy-mm-dd hh:mm:ss to Unix time */
-utime_t str_to_utime(char *str) 
+utime_t str_to_utime(char *str)
 {
    struct tm tm;
-   time_t ttime;
+   time_t time;
+
+   /* Check for bad argument */
+   if (!str || *str == 0) {
+      return 0;
+   }
 
    if (sscanf(str, "%d-%d-%d %d:%d:%d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
-                                       &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
+                                        &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
       return 0;
    }
    if (tm.tm_mon > 0) {
       tm.tm_mon--;
-   } else { 
+   } else {
       return 0;
    }
    if (tm.tm_year >= 1900) {
@@ -100,11 +148,11 @@ utime_t str_to_utime(char *str)
    }
    tm.tm_wday = tm.tm_yday = 0;
    tm.tm_isdst = -1;
-   ttime = mktime(&tm);
-   if (ttime == -1) {      
-      ttime = 0;
+   time = mktime(&tm);
+   if (time == -1) {
+      time = 0;
    }
-   return (utime_t)ttime;
+   return (utime_t)time;
 }
 
 
@@ -126,7 +174,7 @@ btime_t get_current_btime()
 /* Convert btime to Unix time */
 time_t btime_to_unix(btime_t bt)
 {
-   return (time_t)(bt/1000000);                   
+   return (time_t)(bt/1000000);
 }
 
 /* Convert btime to utime */
@@ -136,25 +184,25 @@ utime_t btime_to_utime(btime_t bt)
 }
 
 /*
- * Return the week of the month, base 0 (wpos)
+ * Return the week of the month, base 0 (wom)
  *   given tm_mday and tm_wday. Value returned
  *   can be from 0 to 4 => week1, ... week5
  */
 int tm_wom(int mday, int wday)
 {
-   int fs;                      /* first sunday */
+   int fs;                       /* first sunday */
    fs = (mday%7) - wday;
    if (fs <= 0) {
       fs += 7;
    }
    if (mday <= fs) {
-//    Dmsg2(100, "wom=0 wday=%d <= fs=%d\n", wday, fs);
+//    Dmsg3(100, "mday=%d wom=0 wday=%d <= fs=%d\n", mday, wday, fs);
       return 0;
    }
    int wom = 1 + (mday - fs - 1) / 7;
-// Dmsg3(100, "wom=%d wday=%d fs=%d\n", wom, wday, fs);
+// Dmsg4(100, "mday=%d wom=%d wday=%d fs=%d\n", mday, wom, wday, fs);
    return wom;
-}  
+}
 
 /*
  * Given a Unix date return the week of the year.
@@ -170,13 +218,15 @@ int tm_woy(time_t stime)
    int woy, fty, tm_yday;
    time_t time4;
    struct tm tm;
+
    memset(&tm, 0, sizeof(struct tm));
-   localtime_r(&stime, &tm);
+   (void)localtime_r(&stime, &tm);
    tm_yday = tm.tm_yday;
    tm.tm_mon = 0;
    tm.tm_mday = 4;
+   tm.tm_isdst = 0;                   /* 4 Jan is not DST */ 
    time4 = mktime(&tm);
-   localtime_r(&time4, &tm);
+   (void)localtime_r(&time4, &tm);
    fty = 1 - tm.tm_wday;
    if (fty <= 0) {
       fty += 7;
@@ -195,7 +245,7 @@ void get_current_time(struct date_time *dt)
    time_t now;
 
    now = time(NULL);
-   gmtime_r(&now, &tm);
+   (void)gmtime_r(&now, &tm);
    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,
       tm.tm_hour, tm.tm_min, tm.tm_sec);
    tm_encode(dt, &tm);
@@ -208,7 +258,7 @@ void get_current_time(struct date_time *dt)
 }
 
 
-/*  date_encode  --  Encode civil date as a Julian day number. */
+/*  date_encode  --  Encode civil date as a Julian day number.  */
 
 /* Deprecated. Do not use. */
 fdate_t date_encode(uint32_t year, uint8_t month, uint8_t day)
@@ -226,44 +276,44 @@ fdate_t date_encode(uint32_t year, uint8_t month, uint8_t day)
     y = year;
 
     if (m <= 2) {
-       y--;
-       m += 12;
+        y--;
+        m += 12;
     }
 
     /* Determine whether date is in Julian or Gregorian calendar based on
        canonical date of calendar reform. */
 
     if ((year < 1582) || ((year == 1582) && ((month < 9) || (month == 9 && day < 5)))) {
-       b = 0;
+        b = 0;
     } else {
-       a = ((int) (y / 100));
-       b = 2 - a + (a / 4);
+        a = ((int) (y / 100));
+        b = 2 - a + (a / 4);
     }
 
     return (((int32_t) (365.25 * (y + 4716))) + ((int) (30.6001 * (m + 1))) +
-               day + b - 1524.5);
+                day + b - 1524.5);
 }
 
 /*  time_encode  --  Encode time from hours, minutes, and seconds
-                    into a fraction of a day.  */
+                     into a fraction of a day.  */
 
 /* Deprecated. Do not use. */
 ftime_t time_encode(uint8_t hour, uint8_t minute, uint8_t second,
-                  float32_t second_fraction)
+                   float32_t second_fraction)
 {
     ASSERT((second_fraction >= 0.0) || (second_fraction < 1.0));
     return (ftime_t) (((second + 60L * (minute + 60L * hour)) / 86400.0)) +
-                    second_fraction;
+                     second_fraction;
 }
 
 /*  date_time_encode  --  Set day number and fraction from date
-                         and time.  */
+                          and time.  */
 
 /* Deprecated. Do not use. */
 void date_time_encode(struct date_time *dt,
-                     uint32_t year, uint8_t month, uint8_t day,
-                     uint8_t hour, uint8_t minute, uint8_t second,
-                     float32_t second_fraction)
+                      uint32_t year, uint8_t month, uint8_t day,
+                      uint8_t hour, uint8_t minute, uint8_t second,
+                      float32_t second_fraction)
 {
     dt->julian_day_number = date_encode(year, month, day);
     dt->julian_day_fraction = time_encode(hour, minute, second, second_fraction);
@@ -273,7 +323,7 @@ void date_time_encode(struct date_time *dt,
 
 /* Deprecated. Do not use. */
 void date_decode(fdate_t date, uint32_t *year, uint8_t *month,
-                uint8_t *day)
+                 uint8_t *day)
 {
     fdate_t z, f, a, alpha, b, c, d, e;
 
@@ -282,10 +332,10 @@ void date_decode(fdate_t date, uint32_t *year, uint8_t *month,
     f = date - z;
 
     if (z < 2299161.0) {
-       a = z;
+        a = z;
     } else {
-       alpha = floor((z - 1867216.25) / 36524.25);
-       a = z + 1 + alpha - floor(alpha / 4);
+        alpha = floor((z - 1867216.25) / 36524.25);
+        a = z + 1 + alpha - floor(alpha / 4);
     }
 
     b = a + 1524;
@@ -302,7 +352,7 @@ void date_decode(fdate_t date, uint32_t *year, uint8_t *month,
 
 /* Deprecated. Do not use. */
 void time_decode(ftime_t time, uint8_t *hour, uint8_t *minute,
-                uint8_t *second, float32_t *second_fraction)
+                 uint8_t *second, float32_t *second_fraction)
 {
     uint32_t ij;
 
@@ -311,30 +361,30 @@ void time_decode(ftime_t time, uint8_t *hour, uint8_t *minute,
     *minute = (uint8_t) ((ij / 60L) % 60L);
     *second = (uint8_t) (ij % 60L);
     if (second_fraction != NULL) {
-       *second_fraction = time - floor(time);
+        *second_fraction = (float32_t)(time - floor(time));
     }
 }
 
 /*  date_time_decode  --  Decode a Julian day and day fraction
-                         into civil date and time.  */
+                          into civil date and time.  */
 
 /* Deprecated. Do not use. */
 void date_time_decode(struct date_time *dt,
-                     uint32_t *year, uint8_t *month, uint8_t *day,
-                     uint8_t *hour, uint8_t *minute, uint8_t *second,
-                     float32_t *second_fraction)
+                      uint32_t *year, uint8_t *month, uint8_t *day,
+                      uint8_t *hour, uint8_t *minute, uint8_t *second,
+                      float32_t *second_fraction)
 {
     date_decode(dt->julian_day_number, year, month, day);
     time_decode(dt->julian_day_fraction, hour, minute, second, second_fraction);
 }
 
-/*  tm_encode  --  Encode a civil date and time from a tm structure   
- *                to a Julian day and day fraction.
+/*  tm_encode  --  Encode a civil date and time from a tm structure
+ *                 to a Julian day and day fraction.
  */
 
 /* Deprecated. Do not use. */
 void tm_encode(struct date_time *dt,
-                     struct tm *tm) 
+                      struct tm *tm)
 {
     uint32_t year;
     uint8_t month, day, hour, minute, second;
@@ -351,11 +401,11 @@ void tm_encode(struct date_time *dt,
 
 
 /*  tm_decode  --  Decode a Julian day and day fraction
-                  into civil date and time in tm structure */
+                   into civil date and time in tm structure */
 
 /* Deprecated. Do not use. */
 void tm_decode(struct date_time *dt,
-                     struct tm *tm) 
+                      struct tm *tm)
 {
     uint32_t year;
     uint8_t month, day, hour, minute, second;
@@ -372,21 +422,21 @@ void tm_decode(struct date_time *dt,
 
 
 /*  date_time_compare  --  Compare two dates and times and return
-                          the relationship as follows:
+                           the relationship as follows:
 
-                                   -1    dt1 < dt2
-                                    0    dt1 = dt2
-                                    1    dt1 > dt2
+                                    -1    dt1 < dt2
+                                     0    dt1 = dt2
+                                     1    dt1 > dt2
 */
 
 /* Deprecated. Do not use. */
 int date_time_compare(struct date_time *dt1, struct date_time *dt2)
 {
     if (dt1->julian_day_number == dt2->julian_day_number) {
-       if (dt1->julian_day_fraction == dt2->julian_day_fraction) {
-           return 0;
-       }
-       return (dt1->julian_day_fraction < dt2->julian_day_fraction) ? -1 : 1;
+        if (dt1->julian_day_fraction == dt2->julian_day_fraction) {
+            return 0;
+        }
+        return (dt1->julian_day_fraction < dt2->julian_day_fraction) ? -1 : 1;
     }
     return (dt1->julian_day_number - dt2->julian_day_number) ? -1 : 1;
 }