coreutils/date.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini date implementation for busybox
   4  *
   5  * by Matthew Grant <grantma@anathoth.gen.nz>
   6  *
   7  * iso-format handling added by Robert Griebl <griebl@gmx.de>
   8  * bugfixes and cleanup by Bernhard Reutner-Fischer
   9  *
  10  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  11 */
  12
  13 /* This 'date' command supports only 2 time setting formats,
  14    all the GNU strftime stuff (its in libc, lets use it),
  15    setting time using UTC and displaying it, as well as
  16    an RFC 2822 compliant date output for shell scripting
  17    mail commands */
  18
  19 /* Input parsing code is always bulky - used heavy duty libc stuff as
  20    much as possible, missed out a lot of bounds checking */
  21
  22 //applet:IF_DATE(APPLET(date, BB_DIR_BIN, BB_SUID_DROP))
  23
  24 //kbuild:lib-$(CONFIG_DATE) += date.o
  25
  26 //config:config DATE
  27 //config:       bool "date"
  28 //config:       default y
  29 //config:       help
  30 //config:         date is used to set the system date or display the
  31 //config:         current time in the given format.
  32 //config:
  33 //config:config FEATURE_DATE_ISOFMT
  34 //config:       bool "Enable ISO date format output (-I)"
  35 //config:       default y
  36 //config:       depends on DATE
  37 //config:       help
  38 //config:         Enable option (-I) to output an ISO-8601 compliant
  39 //config:         date/time string.
  40 //config:
  41 //config:# defaults to "no": stat's nanosecond field is a bit non-portable
  42 //config:config FEATURE_DATE_NANO
  43 //config:       bool "Support %[num]N nanosecond format specifier"
  44 //config:       default n
  45 //config:       depends on DATE  # syscall(__NR_clock_gettime)
  46 //config:       select PLATFORM_LINUX
  47 //config:       help
  48 //config:         Support %[num]N format specifier. Adds ~250 bytes of code.
  49 //config:
  50 //config:config FEATURE_DATE_COMPAT
  51 //config:       bool "Support weird 'date MMDDhhmm[[YY]YY][.ss]' format"
  52 //config:       default y
  53 //config:       depends on DATE
  54 //config:       help
  55 //config:         System time can be set by 'date -s DATE' and simply 'date DATE',
  56 //config:         but formats of DATE string are different. 'date DATE' accepts
  57 //config:         a rather weird MMDDhhmm[[YY]YY][.ss] format with completely
  58 //config:         unnatural placement of year between minutes and seconds.
  59 //config:         date -s (and other commands like touch -d) use more sensible
  60 //config:         formats (for one, ISO format YYYY-MM-DD hh:mm:ss.ssssss).
  61 //config:
  62 //config:         With this option off, 'date DATE' is 'date -s DATE' support
  63 //config:         the same format. With it on, 'date DATE' additionally supports
  64 //config:         MMDDhhmm[[YY]YY][.ss] format.
  65
  66 /* GNU coreutils 6.9 man page:
  67  * date [OPTION]... [+FORMAT]
  68  * date [-u|--utc|--universal] [MMDDhhmm[[CC]YY][.ss]]
  69  * -d, --date=STRING
  70  *      display time described by STRING, not `now'
  71  * -f, --file=DATEFILE
  72  *      like --date once for each line of DATEFILE
  73  * -r, --reference=FILE
  74  *      display the last modification time of FILE
  75  * -R, --rfc-2822
  76  *      output date and time in RFC 2822 format.
  77  *      Example: Mon, 07 Aug 2006 12:34:56 -0600
  78  * --rfc-3339=TIMESPEC
  79  *      output date and time in RFC 3339 format.
  80  *      TIMESPEC='date', 'seconds', or 'ns'
  81  *      Date and time components are separated by a single space:
  82  *      2006-08-07 12:34:56-06:00
  83  * -s, --set=STRING
  84  *      set time described by STRING
  85  * -u, --utc, --universal
  86  *      print or set Coordinated Universal Time
  87  *
  88  * Busybox:
  89  * long options are not supported
  90  * -f is not supported
  91  * -I seems to roughly match --rfc-3339, but -I has _optional_ param
  92  *    (thus "-I seconds" doesn't work, only "-Iseconds"),
  93  *    and does not support -Ins
  94  * -D FMT is a bbox extension for _input_ conversion of -d DATE
  95  */
  96
  97 //usage:#define date_trivial_usage
  98 //usage:       "[OPTIONS] [+FMT] [TIME]"
  99 //usage:#define date_full_usage "\n\n"
 100 //usage:       "Display time (using +FMT), or set time\n"
 101 //usage:        IF_NOT_LONG_OPTS(
 102 //usage:     "\n        [-s] TIME       Set time to TIME"
 103 //usage:     "\n        -u              Work in UTC (don't convert to local time)"
 104 //usage:     "\n        -R              Output RFC-2822 compliant date string"
 105 //usage:        ) IF_LONG_OPTS(
 106 //usage:     "\n        [-s,--set] TIME Set time to TIME"
 107 //usage:     "\n        -u,--utc        Work in UTC (don't convert to local time)"
 108 //usage:     "\n        -R,--rfc-2822   Output RFC-2822 compliant date string"
 109 //usage:        )
 110 //usage:        IF_FEATURE_DATE_ISOFMT(
 111 //usage:     "\n        -I[SPEC]        Output ISO-8601 compliant date string"
 112 //usage:     "\n                        SPEC='date' (default) for date only,"
 113 //usage:     "\n                        'hours', 'minutes', or 'seconds' for date and"
 114 //usage:     "\n                        time to the indicated precision"
 115 //usage:        )
 116 //usage:        IF_NOT_LONG_OPTS(
 117 //usage:     "\n        -r FILE         Display last modification time of FILE"
 118 //usage:     "\n        -d TIME         Display TIME, not 'now'"
 119 //usage:        ) IF_LONG_OPTS(
 120 //usage:     "\n        -r,--reference FILE     Display last modification time of FILE"
 121 //usage:     "\n        -d,--date TIME  Display TIME, not 'now'"
 122 //usage:        )
 123 //usage:        IF_FEATURE_DATE_ISOFMT(
 124 //usage:     "\n        -D FMT          Use FMT for -d TIME conversion"
 125 //usage:        )
 126 //usage:     "\n"
 127 //usage:     "\nRecognized TIME formats:"
 128 //usage:     "\n        hh:mm[:ss]"
 129 //usage:     "\n        [YYYY.]MM.DD-hh:mm[:ss]"
 130 //usage:     "\n        YYYY-MM-DD hh:mm[:ss]"
 131 //usage:     "\n        [[[[[YY]YY]MM]DD]hh]mm[.ss]"
 132 //usage:        IF_FEATURE_DATE_COMPAT(
 133 //usage:     "\n        'date TIME' form accepts MMDDhhmm[[YY]YY][.ss] instead"
 134 //usage:        )
 135 //usage:
 136 //usage:#define date_example_usage
 137 //usage:       "$ date\n"
 138 //usage:       "Wed Apr 12 18:52:41 MDT 2000\n"
 139
 140 #include "libbb.h"
 141 #if ENABLE_FEATURE_DATE_NANO
 142 # include <sys/syscall.h>
 143 #endif
 144
 145 enum {
 146         OPT_RFC2822   = (1 << 0), /* R */
 147         OPT_SET       = (1 << 1), /* s */
 148         OPT_UTC       = (1 << 2), /* u */
 149         OPT_DATE      = (1 << 3), /* d */
 150         OPT_REFERENCE = (1 << 4), /* r */
 151         OPT_TIMESPEC  = (1 << 5) * ENABLE_FEATURE_DATE_ISOFMT, /* I */
 152         OPT_HINT      = (1 << 6) * ENABLE_FEATURE_DATE_ISOFMT, /* D */
 153 };
 154
 155 static void maybe_set_utc(int opt)
 156 {
 157         if (opt & OPT_UTC)
 158                 putenv((char*)"TZ=UTC0");
 159 }
 160
 161 #if ENABLE_LONG_OPTS
 162 static const char date_longopts[] ALIGN1 =
 163                 "rfc-822\0"   No_argument       "R"
 164                 "rfc-2822\0"  No_argument       "R"
 165                 "set\0"       Required_argument "s"
 166                 "utc\0"       No_argument       "u"
 167         /*      "universal\0" No_argument       "u" */
 168                 "date\0"      Required_argument "d"
 169                 "reference\0" Required_argument "r"
 170                 ;
 171 #endif
 172
 173 int date_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 174 int date_main(int argc UNUSED_PARAM, char **argv)
 175 {
 176         struct timespec ts;
 177         struct tm tm_time;
 178         char buf_fmt_dt2str[64];
 179         unsigned opt;
 180         int ifmt = -1;
 181         char *date_str;
 182         char *fmt_dt2str;
 183         char *fmt_str2dt;
 184         char *filename;
 185         char *isofmt_arg = NULL;
 186
 187         opt_complementary = "d--s:s--d"
 188                 IF_FEATURE_DATE_ISOFMT(":R--I:I--R");
 189         IF_LONG_OPTS(applet_long_options = date_longopts;)
 190         opt = getopt32(argv, "Rs:ud:r:"
 191                         IF_FEATURE_DATE_ISOFMT("I::D:"),
 192                         &date_str, &date_str, &filename
 193                         IF_FEATURE_DATE_ISOFMT(, &isofmt_arg, &fmt_str2dt));
 194         argv += optind;
 195         maybe_set_utc(opt);
 196
 197         if (ENABLE_FEATURE_DATE_ISOFMT && (opt & OPT_TIMESPEC)) {
 198                 ifmt = 0; /* default is date */
 199                 if (isofmt_arg) {
 200                         static const char isoformats[] ALIGN1 =
 201                                 "date\0""hours\0""minutes\0""seconds\0"; /* ns? */
 202                         ifmt = index_in_substrings(isoformats, isofmt_arg);
 203                         if (ifmt < 0)
 204                                 bb_show_usage();
 205                 }
 206         }
 207
 208         fmt_dt2str = NULL;
 209         if (argv[0] && argv[0][0] == '+') {
 210                 fmt_dt2str = &argv[0][1]; /* skip over the '+' */
 211                 argv++;
 212         }
 213         if (!(opt & (OPT_SET | OPT_DATE))) {
 214                 opt |= OPT_SET;
 215                 date_str = argv[0]; /* can be NULL */
 216                 if (date_str) {
 217 #if ENABLE_FEATURE_DATE_COMPAT
 218                         int len = strspn(date_str, "0123456789");
 219                         if (date_str[len] == '\0'
 220                          || (date_str[len] == '.'
 221                             && isdigit(date_str[len+1])
 222                             && isdigit(date_str[len+2])
 223                             && date_str[len+3] == '\0'
 224                             )
 225                         ) {
 226                                 /* Dreaded MMDDhhmm[[CC]YY][.ss] format!
 227                                  * It does not match -d or -s format.
 228                                  * Some users actually do use it.
 229                                  */
 230                                 len -= 8;
 231                                 if (len < 0 || len > 4 || (len & 1))
 232                                         bb_error_msg_and_die(bb_msg_invalid_date, date_str);
 233                                 if (len != 0) { /* move YY or CCYY to front */
 234                                         char buf[4];
 235                                         memcpy(buf, date_str + 8, len);
 236                                         memmove(date_str + len, date_str, 8);
 237                                         memcpy(date_str, buf, len);
 238                                 }
 239                         }
 240 #endif
 241                         argv++;
 242                 }
 243         }
 244         if (*argv)
 245                 bb_show_usage();
 246
 247         /* Now we have parsed all the information except the date format
 248          * which depends on whether the clock is being set or read */
 249
 250         if (opt & OPT_REFERENCE) {
 251                 struct stat statbuf;
 252                 xstat(filename, &statbuf);
 253                 ts.tv_sec = statbuf.st_mtime;
 254 #if ENABLE_FEATURE_DATE_NANO
 255                 ts.tv_nsec = statbuf.st_mtim.tv_nsec;
 256                 /* Some toolchains use .st_mtimensec instead of st_mtim.tv_nsec.
 257                  * If you need #define _SVID_SOURCE 1 to enable st_mtim.tv_nsec,
 258                  * drop a mail to project mailing list please
 259                  */
 260 #endif
 261         } else {
 262 #if ENABLE_FEATURE_DATE_NANO
 263                 /* libc has incredibly messy way of doing this,
 264                  * typically requiring -lrt. We just skip all this mess */
 265                 syscall(__NR_clock_gettime, CLOCK_REALTIME, &ts);
 266 #else
 267                 time(&ts.tv_sec);
 268 #endif
 269         }
 270         localtime_r(&ts.tv_sec, &tm_time);
 271
 272         /* If date string is given, update tm_time, and maybe set date */
 273         if (date_str != NULL) {
 274                 /* Zero out fields - take her back to midnight! */
 275                 tm_time.tm_sec = 0;
 276                 tm_time.tm_min = 0;
 277                 tm_time.tm_hour = 0;
 278
 279                 /* Process any date input to UNIX time since 1 Jan 1970 */
 280                 if (ENABLE_FEATURE_DATE_ISOFMT && (opt & OPT_HINT)) {
 281                         if (strptime(date_str, fmt_str2dt, &tm_time) == NULL)
 282                                 bb_error_msg_and_die(bb_msg_invalid_date, date_str);
 283                 } else {
 284                         parse_datestr(date_str, &tm_time);
 285                 }
 286
 287                 /* Correct any day of week and day of year etc. fields */
 288                 /* Be sure to recheck dst (but not if date is time_t format) */
 289                 if (date_str[0] != '@')
 290                         tm_time.tm_isdst = -1;
 291                 ts.tv_sec = validate_tm_time(date_str, &tm_time);
 292
 293                 maybe_set_utc(opt);
 294
 295                 /* if setting time, set it */
 296                 if ((opt & OPT_SET) && stime(&ts.tv_sec) < 0) {
 297                         bb_perror_msg("can't set date");
 298                 }
 299         }
 300
 301         /* Display output */
 302
 303         /* Deal with format string */
 304         if (fmt_dt2str == NULL) {
 305                 int i;
 306                 fmt_dt2str = buf_fmt_dt2str;
 307                 if (ENABLE_FEATURE_DATE_ISOFMT && ifmt >= 0) {
 308                         /* -I[SPEC]: 0:date 1:hours 2:minutes 3:seconds */
 309                         strcpy(fmt_dt2str, "%Y-%m-%dT%H:%M:%S");
 310                         i = 8 + 3 * ifmt;
 311                         if (ifmt != 0) {
 312                                 /* TODO: if (ifmt==4) i += sprintf(&fmt_dt2str[i], ",%09u", nanoseconds); */
 313  format_utc:
 314                                 fmt_dt2str[i++] = '%';
 315                                 fmt_dt2str[i++] = (opt & OPT_UTC) ? 'Z' : 'z';
 316                         }
 317                         fmt_dt2str[i] = '\0';
 318                 } else if (opt & OPT_RFC2822) {
 319                         /* -R. undo busybox.c setlocale */
 320                         if (ENABLE_LOCALE_SUPPORT)
 321                                 setlocale(LC_TIME, "C");
 322                         strcpy(fmt_dt2str, "%a, %d %b %Y %H:%M:%S ");
 323                         i = sizeof("%a, %d %b %Y %H:%M:%S ")-1;
 324                         goto format_utc;
 325                 } else { /* default case */
 326                         fmt_dt2str = (char*)"%a %b %e %H:%M:%S %Z %Y";
 327                 }
 328         }
 329 #if ENABLE_FEATURE_DATE_NANO
 330         else {
 331                 /* User-specified fmt_dt2str */
 332                 /* Search for and process "%N" */
 333                 char *p = fmt_dt2str;
 334                 while ((p = strchr(p, '%')) != NULL) {
 335                         int n, m;
 336                         unsigned pres, scale;
 337
 338                         p++;
 339                         if (*p == '%') {
 340                                 p++;
 341                                 continue;
 342                         }
 343                         n = strspn(p, "0123456789");
 344                         if (p[n] != 'N') {
 345                                 p += n;
 346                                 continue;
 347                         }
 348                         /* We have "%[nnn]N" */
 349                         p[-1] = '\0';
 350                         p[n] = '\0';
 351                         scale = 1;
 352                         pres = 9;
 353                         if (n) {
 354                                 pres = xatoi_positive(p);
 355                                 if (pres == 0)
 356                                         pres = 9;
 357                                 m = 9 - pres;
 358                                 while (--m >= 0)
 359                                         scale *= 10;
 360                         }
 361
 362                         m = p - fmt_dt2str;
 363                         p += n + 1;
 364                         fmt_dt2str = xasprintf("%s%0*u%s", fmt_dt2str, pres, (unsigned)ts.tv_nsec / scale, p);
 365                         p = fmt_dt2str + m;
 366                 }
 367         }
 368 #endif
 369
 370 #define date_buf bb_common_bufsiz1
 371         if (*fmt_dt2str == '\0') {
 372                 /* With no format string, just print a blank line */
 373                 date_buf[0] = '\0';
 374         } else {
 375                 /* Handle special conversions */
 376                 if (strncmp(fmt_dt2str, "%f", 2) == 0) {
 377                         fmt_dt2str = (char*)"%Y.%m.%d-%H:%M:%S";
 378                 }
 379                 /* Generate output string */
 380                 strftime(date_buf, sizeof(date_buf), fmt_dt2str, &tm_time);
 381         }
 382         puts(date_buf);
 383
 384         return EXIT_SUCCESS;
 385 }