src/date.c

   1 /* date - print or set the system date and time
   2    Copyright (C) 1989-2004 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18    David MacKenzie <djm@gnu.ai.mit.edu> */
  19
  20 #include <config.h>
  21 #include <stdio.h>
  22 #include <getopt.h>
  23 #include <sys/types.h>
  24 #if HAVE_LANGINFO_CODESET
  25 # include <langinfo.h>
  26 #endif
  27
  28 #include "system.h"
  29 #include "argmatch.h"
  30 #include "error.h"
  31 #include "getdate.h"
  32 #include "getline.h"
  33 #include "inttostr.h"
  34 #include "posixtm.h"
  35 #include "posixver.h"
  36 #include "quote.h"
  37 #include "strftime.h"
  38
  39 /* The official name of this program (e.g., no `g' prefix).  */
  40 #define PROGRAM_NAME "date"
  41
  42 #define AUTHORS "David MacKenzie"
  43
  44 int putenv ();
  45
  46 static bool show_date (const char *format, struct timespec when);
  47
  48 enum Time_spec
  49 {
  50   /* display only the date: 1999-03-25 */
  51   TIME_SPEC_DATE=1,
  52   /* display date and hour: 1999-03-25T03-0500 */
  53   TIME_SPEC_HOURS,
  54   /* display date, hours, and minutes: 1999-03-25T03:23-0500 */
  55   TIME_SPEC_MINUTES,
  56   /* display date, hours, minutes, and seconds: 1999-03-25T03:23:14-0500 */
  57   TIME_SPEC_SECONDS,
  58   /* similar, but display nanoseconds: 1999-03-25T03:23:14,123456789-0500 */
  59   TIME_SPEC_NS
  60 };
  61
  62 static char const *const time_spec_string[] =
  63 {
  64   "date", "hours", "minutes", "seconds", "ns", 0
  65 };
  66
  67 static enum Time_spec const time_spec[] =
  68 {
  69   TIME_SPEC_DATE, TIME_SPEC_HOURS, TIME_SPEC_MINUTES, TIME_SPEC_SECONDS,
  70   TIME_SPEC_NS
  71 };
  72
  73 /* The name this program was run with, for error messages. */
  74 char *program_name;
  75
  76 /* If nonzero, display an ISO 8601 format date/time string */
  77 static int iso_8601_format = 0;
  78
  79 /* If true, display time in RFC-(2)822 format for mail or news. */
  80 static bool rfc_format = false;
  81
  82 #define COMMON_SHORT_OPTIONS "Rd:f:r:s:u"
  83
  84 static struct option const long_options[] =
  85 {
  86   {"date", required_argument, NULL, 'd'},
  87   {"file", required_argument, NULL, 'f'},
  88   {"iso-8601", optional_argument, NULL, 'I'},
  89   {"reference", required_argument, NULL, 'r'},
  90   {"rfc-822", no_argument, NULL, 'R'},
  91   {"rfc-2822", no_argument, NULL, 'R'},
  92   {"set", required_argument, NULL, 's'},
  93   {"uct", no_argument, NULL, 'u'},
  94   {"utc", no_argument, NULL, 'u'},
  95   {"universal", no_argument, NULL, 'u'},
  96   {GETOPT_HELP_OPTION_DECL},
  97   {GETOPT_VERSION_OPTION_DECL},
  98   {NULL, 0, NULL, 0}
  99 };
 100
 101 #if LOCALTIME_CACHE
 102 # define TZSET tzset ()
 103 #else
 104 # define TZSET /* empty */
 105 #endif
 106
 107 #ifdef _DATE_FMT
 108 # define DATE_FMT_LANGINFO() nl_langinfo (_DATE_FMT)
 109 #else
 110 # define DATE_FMT_LANGINFO() ""
 111 #endif
 112
 113 void
 114 usage (int status)
 115 {
 116   if (status != EXIT_SUCCESS)
 117     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 118              program_name);
 119   else
 120     {
 121       printf (_("\
 122 Usage: %s [OPTION]... [+FORMAT]\n\
 123   or:  %s [-u|--utc|--universal] [MMDDhhmm[[CC]YY][.ss]]\n\
 124 "),
 125               program_name, program_name);
 126       fputs (_("\
 127 Display the current time in the given FORMAT, or set the system date.\n\
 128 \n\
 129   -d, --date=STRING         display time described by STRING, not `now'\n\
 130   -f, --file=DATEFILE       like --date once for each line of DATEFILE\n\
 131       --iso-8601[=TIMESPEC] output date/time in ISO 8601 format.\n\
 132                             TIMESPEC=`date' for date only (the default),\n\
 133                             `hours', `minutes', `seconds', or `ns' for date and\n\
 134                             time to the indicated precision.\n\
 135 "), stdout);
 136       fputs (_("\
 137   -r, --reference=FILE      display the last modification time of FILE\n\
 138   -R, --rfc-2822            output RFC-2822 compliant date string\n\
 139   -s, --set=STRING          set time described by STRING\n\
 140   -u, --utc, --universal    print or set Coordinated Universal Time\n\
 141 "), stdout);
 142       fputs (HELP_OPTION_DESCRIPTION, stdout);
 143       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 144       fputs (_("\
 145 \n\
 146 FORMAT controls the output.  The only valid option for the second form\n\
 147 specifies Coordinated Universal Time.  Interpreted sequences are:\n\
 148 \n\
 149   %%   a literal %\n\
 150   %a   locale's abbreviated weekday name (Sun..Sat)\n\
 151 "), stdout);
 152       fputs (_("\
 153   %A   locale's full weekday name, variable length (Sunday..Saturday)\n\
 154   %b   locale's abbreviated month name (Jan..Dec)\n\
 155   %B   locale's full month name, variable length (January..December)\n\
 156   %c   locale's date and time (Sat Nov 04 12:02:33 EST 1989)\n\
 157 "), stdout);
 158       fputs (_("\
 159   %C   century (year divided by 100 and truncated to an integer) [00-99]\n\
 160   %d   day of month (01..31)\n\
 161   %D   date (mm/dd/yy)\n\
 162   %e   day of month, blank padded ( 1..31)\n\
 163 "), stdout);
 164       fputs (_("\
 165   %F   same as %Y-%m-%d\n\
 166   %g   the 2-digit year corresponding to the %V week number\n\
 167   %G   the 4-digit year corresponding to the %V week number\n\
 168 "), stdout);
 169       fputs (_("\
 170   %h   same as %b\n\
 171   %H   hour (00..23)\n\
 172   %I   hour (01..12)\n\
 173   %j   day of year (001..366)\n\
 174 "), stdout);
 175       fputs (_("\
 176   %k   hour ( 0..23)\n\
 177   %l   hour ( 1..12)\n\
 178   %m   month (01..12)\n\
 179   %M   minute (00..59)\n\
 180 "), stdout);
 181       fputs (_("\
 182   %n   a newline\n\
 183   %N   nanoseconds (000000000..999999999)\n\
 184   %p   locale's upper case AM or PM indicator (blank in many locales)\n\
 185   %P   locale's lower case am or pm indicator (blank in many locales)\n\
 186   %r   time, 12-hour (hh:mm:ss [AP]M)\n\
 187   %R   time, 24-hour (hh:mm)\n\
 188   %s   seconds since `00:00:00 1970-01-01 UTC' (a GNU extension)\n\
 189 "), stdout);
 190       fputs (_("\
 191   %S   second (00..60); the 60 is necessary to accommodate a leap second\n\
 192   %t   a horizontal tab\n\
 193   %T   time, 24-hour (hh:mm:ss)\n\
 194   %u   day of week (1..7);  1 represents Monday\n\
 195 "), stdout);
 196       fputs (_("\
 197   %U   week number of year with Sunday as first day of week (00..53)\n\
 198   %V   week number of year with Monday as first day of week (01..53)\n\
 199   %w   day of week (0..6);  0 represents Sunday\n\
 200   %W   week number of year with Monday as first day of week (00..53)\n\
 201 "), stdout);
 202       fputs (_("\
 203   %x   locale's date representation (mm/dd/yy)\n\
 204   %X   locale's time representation (%H:%M:%S)\n\
 205   %y   last two digits of year (00..99)\n\
 206   %Y   year (1970...)\n\
 207 "), stdout);
 208       fputs (_("\
 209   %z   RFC-2822 style numeric timezone (-0500) (a nonstandard extension)\n\
 210   %Z   time zone (e.g., EDT), or nothing if no time zone is determinable\n\
 211 \n\
 212 By default, date pads numeric fields with zeroes.  GNU date recognizes\n\
 213 the following modifiers between `%' and a numeric directive.\n\
 214 \n\
 215   `-' (hyphen) do not pad the field\n\
 216   `_' (underscore) pad the field with spaces\n\
 217 "), stdout);
 218       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 219     }
 220   exit (status);
 221 }
 222
 223 /* Parse each line in INPUT_FILENAME as with --date and display each
 224    resulting time and date.  If the file cannot be opened, tell why
 225    then exit.  Issue a diagnostic for any lines that cannot be parsed.
 226    Return true if successful.  */
 227
 228 static bool
 229 batch_convert (const char *input_filename, const char *format)
 230 {
 231   bool ok;
 232   FILE *in_stream;
 233   char *line;
 234   size_t buflen;
 235   struct timespec when;
 236
 237   if (STREQ (input_filename, "-"))
 238     {
 239       input_filename = _("standard input");
 240       in_stream = stdin;
 241     }
 242   else
 243     {
 244       in_stream = fopen (input_filename, "r");
 245       if (in_stream == NULL)
 246         {
 247           error (EXIT_FAILURE, errno, "%s", quote (input_filename));
 248         }
 249     }
 250
 251   line = NULL;
 252   buflen = 0;
 253   ok = true;
 254   while (1)
 255     {
 256       ssize_t line_length = getline (&line, &buflen, in_stream);
 257       if (line_length < 0)
 258         {
 259           /* FIXME: detect/handle error here.  */
 260           break;
 261         }
 262
 263       if (! get_date (&when, line, NULL))
 264         {
 265           if (line[line_length - 1] == '\n')
 266             line[line_length - 1] = '\0';
 267           error (0, 0, _("invalid date `%s'"), line);
 268           ok = false;
 269         }
 270       else
 271         {
 272           ok &= show_date (format, when);
 273         }
 274     }
 275
 276   if (fclose (in_stream) == EOF)
 277     error (EXIT_FAILURE, errno, "%s", quote (input_filename));
 278
 279   if (line != NULL)
 280     free (line);
 281
 282   return ok;
 283 }
 284
 285 int
 286 main (int argc, char **argv)
 287 {
 288   int optc;
 289   const char *datestr = NULL;
 290   const char *set_datestr = NULL;
 291   struct timespec when;
 292   bool set_date = false;
 293   char *format;
 294   char *batch_file = NULL;
 295   char *reference = NULL;
 296   struct stat refstats;
 297   int n_args;
 298   bool ok;
 299   int option_specified_date;
 300   char const *short_options = (posix2_version () < 200112
 301                                ? COMMON_SHORT_OPTIONS "I::"
 302                                : COMMON_SHORT_OPTIONS "I:");
 303
 304   initialize_main (&argc, &argv);
 305   program_name = argv[0];
 306   setlocale (LC_ALL, "");
 307   bindtextdomain (PACKAGE, LOCALEDIR);
 308   textdomain (PACKAGE);
 309
 310   atexit (close_stdout);
 311
 312   while ((optc = getopt_long (argc, argv, short_options, long_options, NULL))
 313          != -1)
 314     switch (optc)
 315       {
 316       case 0:
 317         break;
 318       case 'd':
 319         datestr = optarg;
 320         break;
 321       case 'f':
 322         batch_file = optarg;
 323         break;
 324       case 'I':
 325         iso_8601_format = (optarg
 326                            ? XARGMATCH ("--iso-8601", optarg,
 327                                         time_spec_string, time_spec)
 328                            : TIME_SPEC_DATE);
 329         break;
 330       case 'r':
 331         reference = optarg;
 332         break;
 333       case 'R':
 334         rfc_format = true;
 335         break;
 336       case 's':
 337         set_datestr = optarg;
 338         set_date = true;
 339         break;
 340       case 'u':
 341         /* POSIX says that `date -u' is equivalent to setting the TZ
 342            environment variable, so this option should do nothing other
 343            than setting TZ.  */
 344         if (putenv ("TZ=UTC0") != 0)
 345           xalloc_die ();
 346         TZSET;
 347         break;
 348       case_GETOPT_HELP_CHAR;
 349       case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 350       default:
 351         usage (EXIT_FAILURE);
 352       }
 353
 354   n_args = argc - optind;
 355
 356   option_specified_date = ((datestr ? 1 : 0)
 357                            + (batch_file ? 1 : 0)
 358                            + (reference ? 1 : 0));
 359
 360   if (option_specified_date > 1)
 361     {
 362       error (0, 0,
 363         _("the options to specify dates for printing are mutually exclusive"));
 364       usage (EXIT_FAILURE);
 365     }
 366
 367   if (set_date && option_specified_date)
 368     {
 369       error (0, 0,
 370           _("the options to print and set the time may not be used together"));
 371       usage (EXIT_FAILURE);
 372     }
 373
 374   if (n_args > 1)
 375     {
 376       error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
 377       usage (EXIT_FAILURE);
 378     }
 379
 380   if ((set_date || option_specified_date)
 381       && n_args == 1 && argv[optind][0] != '+')
 382     {
 383       error (0, 0, _("\
 384 the argument `%s' lacks a leading `+';\n\
 385 When using an option to specify date(s), any non-option\n\
 386 argument must be a format string beginning with `+'."),
 387              argv[optind]);
 388       usage (EXIT_FAILURE);
 389     }
 390
 391   /* Simply ignore --rfc-2822 if specified when setting the date.  */
 392   if (rfc_format && !set_date && n_args > 0)
 393     {
 394       error (0, 0,
 395              _("a format string may not be specified when using\
 396  the --rfc-2822 (-R) option"));
 397       usage (EXIT_FAILURE);
 398     }
 399
 400   if (set_date)
 401     datestr = set_datestr;
 402
 403   if (batch_file != NULL)
 404     ok = batch_convert (batch_file, (n_args == 1 ? argv[optind] + 1 : NULL));
 405   else
 406     {
 407       bool valid_date = true;
 408       ok = true;
 409
 410       if (!option_specified_date && !set_date)
 411         {
 412           if (n_args == 1 && argv[optind][0] != '+')
 413             {
 414               /* Prepare to set system clock to the specified date/time
 415                  given in the POSIX-format.  */
 416               set_date = true;
 417               datestr = argv[optind];
 418               valid_date = posixtime (&when.tv_sec,
 419                                       datestr,
 420                                       (PDS_TRAILING_YEAR
 421                                        | PDS_CENTURY | PDS_SECONDS));
 422               when.tv_nsec = 0; /* FIXME: posixtime should set this.  */
 423               format = NULL;
 424             }
 425           else
 426             {
 427               /* Prepare to print the current date/time.  */
 428               datestr = _("undefined");
 429               if (gettime (&when) != 0)
 430                 error (EXIT_FAILURE, errno, _("cannot get time of day"));
 431               format = (n_args == 1 ? argv[optind] + 1 : NULL);
 432             }
 433         }
 434       else
 435         {
 436           /* (option_specified_date || set_date) */
 437           if (reference != NULL)
 438             {
 439               if (stat (reference, &refstats))
 440                 error (EXIT_FAILURE, errno, "%s", reference);
 441               when.tv_sec = refstats.st_mtime;
 442               when.tv_nsec = TIMESPEC_NS (refstats.st_mtim);
 443             }
 444           else
 445             {
 446               valid_date = get_date (&when, datestr, NULL);
 447             }
 448
 449           format = (n_args == 1 ? argv[optind] + 1 : NULL);
 450         }
 451
 452       if (! valid_date)
 453         error (EXIT_FAILURE, 0, _("invalid date `%s'"), datestr);
 454
 455       if (set_date)
 456         {
 457           /* Set the system clock to the specified date, then regardless of
 458              the success of that operation, format and print that date.  */
 459           if (settime (&when) != 0)
 460             {
 461               error (0, errno, _("cannot set date"));
 462               ok = false;
 463             }
 464         }
 465
 466       ok &= show_date (format, when);
 467     }
 468
 469   exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);
 470 }
 471
 472 /* Display the date and/or time in WHEN according to the format specified
 473    in FORMAT, followed by a newline.  If FORMAT is NULL, use the
 474    standard output format (ctime style but with a timezone inserted).
 475    Return true if successful.  */
 476
 477 static bool
 478 show_date (const char *format, struct timespec when)
 479 {
 480   struct tm *tm;
 481   char *out = NULL;
 482   size_t out_length = 0;
 483   /* ISO 8601 formats.  See below regarding %z */
 484   static char const * const iso_format_string[] =
 485   {
 486     "%Y-%m-%d",
 487     "%Y-%m-%dT%H%z",
 488     "%Y-%m-%dT%H:%M%z",
 489     "%Y-%m-%dT%H:%M:%S%z",
 490     "%Y-%m-%dT%H:%M:%S,%N%z"
 491   };
 492
 493   if (format == NULL)
 494     {
 495       if (rfc_format)
 496         format = "%a, %d %b %Y %H:%M:%S %z";
 497       else if (iso_8601_format)
 498         format = iso_format_string[iso_8601_format - 1];
 499       else
 500         {
 501           char *date_fmt = DATE_FMT_LANGINFO ();
 502           /* Do not wrap the following literal format string with _(...).
 503              For example, suppose LC_ALL is unset, LC_TIME="POSIX",
 504              and LANG="ko_KR".  In that case, POSIX says that LC_TIME
 505              determines the format and contents of date and time strings
 506              written by date, which means "date" must generate output
 507              using the POSIX locale; but adding _() would cause "date"
 508              to use a Korean translation of the format.  */
 509           format = *date_fmt ? date_fmt : "%a %b %e %H:%M:%S %Z %Y";
 510         }
 511     }
 512   else if (*format == '\0')
 513     {
 514       printf ("\n");
 515       return true;
 516     }
 517
 518   tm = localtime (&when.tv_sec);
 519   if (! tm)
 520     {
 521       char buf[INT_BUFSIZE_BOUND (intmax_t)];
 522       error (0, 0, _("time %s is out of range"),
 523              (TYPE_SIGNED (time_t)
 524               ? imaxtostr (when.tv_sec, buf)
 525               : umaxtostr (when.tv_sec, buf)));
 526       puts (buf);
 527       return false;
 528     }
 529
 530   while (1)
 531     {
 532       bool done;
 533       out = x2nrealloc (out, &out_length, sizeof *out);
 534
 535       /* Mark the first byte of the buffer so we can detect the case
 536          of nstrftime producing an empty string.  Otherwise, this loop
 537          would not terminate when date was invoked like this
 538          `LANG=de date +%p' on a system with good language support.  */
 539       out[0] = '\1';
 540
 541       if (rfc_format)
 542         setlocale (LC_ALL, "C");
 543
 544       done = (nstrftime (out, out_length, format, tm, 0, when.tv_nsec)
 545               || out[0] == '\0');
 546
 547       if (rfc_format)
 548         setlocale (LC_ALL, "");
 549
 550       if (done)
 551         break;
 552     }
 553
 554   printf ("%s\n", out);
 555   free (out);
 556   return true;
 557 }