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