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:     "\nOptions:"
 102 //usage:        IF_NOT_LONG_OPTS(
 103 //usage:     "\n        [-s] TIME       Set time to TIME"
 104 //usage:     "\n        -u              Work in UTC (don't convert to local time)"
 105 //usage:     "\n        -R              Output RFC-2822 compliant date string"
 106 //usage:        ) IF_LONG_OPTS(
 107 //usage:     "\n        [-s,--set] TIME Set time to TIME"
 108 //usage:     "\n        -u,--utc        Work in UTC (don't convert to local time)"
 109 //usage:     "\n        -R,--rfc-2822   Output RFC-2822 compliant date string"
 110 //usage:        )
 111 //usage:        IF_FEATURE_DATE_ISOFMT(
 112 //usage:     "\n        -I[SPEC]        Output ISO-8601 compliant date string"
 113 //usage:     "\n                        SPEC='date' (default) for date only,"
 114 //usage:     "\n                        'hours', 'minutes', or 'seconds' for date and"
 115 //usage:     "\n                        time to the indicated precision"
 116 //usage:        )
 117 //usage:        IF_NOT_LONG_OPTS(
 118 //usage:     "\n        -r FILE         Display last modification time of FILE"
 119 //usage:     "\n        -d TIME         Display TIME, not 'now'"
 120 //usage:        ) IF_LONG_OPTS(
 121 //usage:     "\n        -r,--reference FILE     Display last modification time of FILE"
 122 //usage:     "\n        -d,--date TIME  Display TIME, not 'now'"
 123 //usage:        )
 124 //usage:        IF_FEATURE_DATE_ISOFMT(
 125 //usage:     "\n        -D FMT          Use FMT for -d TIME conversion"
 126 //usage:        )
 127 //usage:     "\n"
 128 //usage:     "\nRecognized TIME formats:"
 129 //usage:     "\n        hh:mm[:ss]"
 130 //usage:     "\n        [YYYY.]MM.DD-hh:mm[:ss]"
 131 //usage:     "\n        YYYY-MM-DD hh:mm[:ss]"
 132 //usage:     "\n        [[[[[YY]YY]MM]DD]hh]mm[.ss]"
 133 //usage:
 134 //usage:#define date_example_usage
 135 //usage:       "$ date\n"
 136 //usage:       "Wed Apr 12 18:52:41 MDT 2000\n"
 137
 138 #include "libbb.h"
 139 #if ENABLE_FEATURE_DATE_NANO
 140 # include <sys/syscall.h>
 141 #endif
 142
 143 enum {
 144         OPT_RFC2822   = (1 << 0), /* R */
 145         OPT_SET       = (1 << 1), /* s */
 146         OPT_UTC       = (1 << 2), /* u */
 147         OPT_DATE      = (1 << 3), /* d */
 148         OPT_REFERENCE = (1 << 4), /* r */
 149         OPT_TIMESPEC  = (1 << 5) * ENABLE_FEATURE_DATE_ISOFMT, /* I */
 150         OPT_HINT      = (1 << 6) * ENABLE_FEATURE_DATE_ISOFMT, /* D */
 151 };
 152
 153 static void maybe_set_utc(int opt)
 154 {
 155         if (opt & OPT_UTC)
 156                 putenv((char*)"TZ=UTC0");
 157 }
 158
 159 #if ENABLE_LONG_OPTS
 160 static const char date_longopts[] ALIGN1 =
 161                 "rfc-822\0"   No_argument       "R"
 162                 "rfc-2822\0"  No_argument       "R"
 163                 "set\0"       Required_argument "s"
 164                 "utc\0"       No_argument       "u"
 165         /*      "universal\0" No_argument       "u" */
 166                 "date\0"      Required_argument "d"
 167                 "reference\0" Required_argument "r"
 168                 ;
 169 #endif
 170
 171 int date_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 172 int date_main(int argc UNUSED_PARAM, char **argv)
 173 {
 174         struct timespec ts;
 175         struct tm tm_time;
 176         char buf_fmt_dt2str[64];
 177         unsigned opt;
 178         int ifmt = -1;
 179         char *date_str;
 180         char *fmt_dt2str;
 181         char *fmt_str2dt;
 182         char *filename;
 183         char *isofmt_arg = NULL;
 184
 185         opt_complementary = "d--s:s--d"
 186                 IF_FEATURE_DATE_ISOFMT(":R--I:I--R");
 187         IF_LONG_OPTS(applet_long_options = date_longopts;)
 188         opt = getopt32(argv, "Rs:ud:r:"
 189                         IF_FEATURE_DATE_ISOFMT("I::D:"),
 190                         &date_str, &date_str, &filename
 191                         IF_FEATURE_DATE_ISOFMT(, &isofmt_arg, &fmt_str2dt));
 192         argv += optind;
 193         maybe_set_utc(opt);
 194
 195         if (ENABLE_FEATURE_DATE_ISOFMT && (opt & OPT_TIMESPEC)) {
 196                 ifmt = 0; /* default is date */
 197                 if (isofmt_arg) {
 198                         static const char isoformats[] ALIGN1 =
 199                                 "date\0""hours\0""minutes\0""seconds\0"; /* ns? */
 200                         ifmt = index_in_substrings(isoformats, isofmt_arg);
 201                         if (ifmt < 0)
 202                                 bb_show_usage();
 203                 }
 204         }
 205
 206         fmt_dt2str = NULL;
 207         if (argv[0] && argv[0][0] == '+') {
 208                 fmt_dt2str = &argv[0][1]; /* skip over the '+' */
 209                 argv++;
 210         }
 211         if (!(opt & (OPT_SET | OPT_DATE))) {
 212                 opt |= OPT_SET;
 213                 date_str = argv[0]; /* can be NULL */
 214                 if (date_str) {
 215 #if ENABLE_FEATURE_DATE_COMPAT
 216                         int len = strspn(date_str, "0123456789");
 217                         if (date_str[len] == '\0'
 218                          || (date_str[len] == '.'
 219                             && isdigit(date_str[len+1])
 220                             && isdigit(date_str[len+2])
 221                             && date_str[len+3] == '\0'
 222                             )
 223                         ) {
 224                                 /* Dreaded MMDDhhmm[[CC]YY][.ss] format!
 225                                  * It does not match -d or -s format.
 226                                  * Some users actually do use it.
 227                                  */
 228                                 len -= 8;
 229                                 if (len < 0 || len > 4 || (len & 1))
 230                                         bb_error_msg_and_die(bb_msg_invalid_date, date_str);
 231                                 if (len != 0) { /* move YY or CCYY to front */
 232                                         char buf[4];
 233                                         memcpy(buf, date_str + 8, len);
 234                                         memmove(date_str + len, date_str, 8);
 235                                         memcpy(date_str, buf, len);
 236                                 }
 237                         }
 238 #endif
 239                         argv++;
 240                 }
 241         }
 242         if (*argv)
 243                 bb_show_usage();
 244
 245         /* Now we have parsed all the information except the date format
 246          * which depends on whether the clock is being set or read */
 247
 248         if (opt & OPT_REFERENCE) {
 249                 struct stat statbuf;
 250                 xstat(filename, &statbuf);
 251                 ts.tv_sec = statbuf.st_mtime;
 252 #if ENABLE_FEATURE_DATE_NANO
 253                 ts.tv_nsec = statbuf.st_mtim.tv_nsec;
 254                 /* Some toolchains use .st_mtimensec instead of st_mtim.tv_nsec.
 255                  * If you need #define _SVID_SOURCE 1 to enable st_mtim.tv_nsec,
 256                  * drop a mail to project mailing list please
 257                  */
 258 #endif
 259         } else {
 260 #if ENABLE_FEATURE_DATE_NANO
 261                 /* libc has incredibly messy way of doing this,
 262                  * typically requiring -lrt. We just skip all this mess */
 263                 syscall(__NR_clock_gettime, CLOCK_REALTIME, &ts);
 264 #else
 265                 time(&ts.tv_sec);
 266 #endif
 267         }
 268         localtime_r(&ts.tv_sec, &tm_time);
 269
 270         /* If date string is given, update tm_time, and maybe set date */
 271         if (date_str != NULL) {
 272                 /* Zero out fields - take her back to midnight! */
 273                 tm_time.tm_sec = 0;
 274                 tm_time.tm_min = 0;
 275                 tm_time.tm_hour = 0;
 276
 277                 /* Process any date input to UNIX time since 1 Jan 1970 */
 278                 if (ENABLE_FEATURE_DATE_ISOFMT && (opt & OPT_HINT)) {
 279                         if (strptime(date_str, fmt_str2dt, &tm_time) == NULL)
 280                                 bb_error_msg_and_die(bb_msg_invalid_date, date_str);
 281                 } else {
 282                         parse_datestr(date_str, &tm_time);
 283                 }
 284
 285                 /* Correct any day of week and day of year etc. fields */
 286                 /* Be sure to recheck dst (but not if date is time_t format) */
 287                 if (date_str[0] != '@')
 288                         tm_time.tm_isdst = -1;
 289                 ts.tv_sec = validate_tm_time(date_str, &tm_time);
 290
 291                 maybe_set_utc(opt);
 292
 293                 /* if setting time, set it */
 294                 if ((opt & OPT_SET) && stime(&ts.tv_sec) < 0) {
 295                         bb_perror_msg("can't set date");
 296                 }
 297         }
 298
 299         /* Display output */
 300
 301         /* Deal with format string */
 302         if (fmt_dt2str == NULL) {
 303                 int i;
 304                 fmt_dt2str = buf_fmt_dt2str;
 305                 if (ENABLE_FEATURE_DATE_ISOFMT && ifmt >= 0) {
 306                         /* -I[SPEC]: 0:date 1:hours 2:minutes 3:seconds */
 307                         strcpy(fmt_dt2str, "%Y-%m-%dT%H:%M:%S");
 308                         i = 8 + 3 * ifmt;
 309                         if (ifmt != 0) {
 310                                 /* TODO: if (ifmt==4) i += sprintf(&fmt_dt2str[i], ",%09u", nanoseconds); */
 311  format_utc:
 312                                 fmt_dt2str[i++] = '%';
 313                                 fmt_dt2str[i++] = (opt & OPT_UTC) ? 'Z' : 'z';
 314                         }
 315                         fmt_dt2str[i] = '\0';
 316                 } else if (opt & OPT_RFC2822) {
 317                         /* -R. undo busybox.c setlocale */
 318                         if (ENABLE_LOCALE_SUPPORT)
 319                                 setlocale(LC_TIME, "C");
 320                         strcpy(fmt_dt2str, "%a, %d %b %Y %H:%M:%S ");
 321                         i = sizeof("%a, %d %b %Y %H:%M:%S ")-1;
 322                         goto format_utc;
 323                 } else { /* default case */
 324                         fmt_dt2str = (char*)"%a %b %e %H:%M:%S %Z %Y";
 325                 }
 326         }
 327 #if ENABLE_FEATURE_DATE_NANO
 328         else {
 329                 /* User-specified fmt_dt2str */
 330                 /* Search for and process "%N" */
 331                 char *p = fmt_dt2str;
 332                 while ((p = strchr(p, '%')) != NULL) {
 333                         int n, m;
 334                         unsigned pres, scale;
 335
 336                         p++;
 337                         if (*p == '%') {
 338                                 p++;
 339                                 continue;
 340                         }
 341                         n = strspn(p, "0123456789");
 342                         if (p[n] != 'N') {
 343                                 p += n;
 344                                 continue;
 345                         }
 346                         /* We have "%[nnn]N" */
 347                         p[-1] = '\0';
 348                         p[n] = '\0';
 349                         scale = 1;
 350                         pres = 9;
 351                         if (n) {
 352                                 pres = xatoi_positive(p);
 353                                 if (pres == 0)
 354                                         pres = 9;
 355                                 m = 9 - pres;
 356                                 while (--m >= 0)
 357                                         scale *= 10;
 358                         }
 359
 360                         m = p - fmt_dt2str;
 361                         p += n + 1;
 362                         fmt_dt2str = xasprintf("%s%0*u%s", fmt_dt2str, pres, (unsigned)ts.tv_nsec / scale, p);
 363                         p = fmt_dt2str + m;
 364                 }
 365         }
 366 #endif
 367
 368 #define date_buf bb_common_bufsiz1
 369         if (*fmt_dt2str == '\0') {
 370                 /* With no format string, just print a blank line */
 371                 date_buf[0] = '\0';
 372         } else {
 373                 /* Handle special conversions */
 374                 if (strncmp(fmt_dt2str, "%f", 2) == 0) {
 375                         fmt_dt2str = (char*)"%Y.%m.%d-%H:%M:%S";
 376                 }
 377                 /* Generate output string */
 378                 strftime(date_buf, sizeof(date_buf), fmt_dt2str, &tm_time);
 379         }
 380         puts(date_buf);
 381
 382         return EXIT_SUCCESS;
 383 }