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 'd':
 317         datestr = optarg;
 318         break;
 319       case 'f':
 320         batch_file = optarg;
 321         break;
 322       case 'I':
 323         iso_8601_format = (optarg
 324                            ? XARGMATCH ("--iso-8601", optarg,
 325                                         time_spec_string, time_spec)
 326                            : TIME_SPEC_DATE);
 327         break;
 328       case 'r':
 329         reference = optarg;
 330         break;
 331       case 'R':
 332         rfc_format = true;
 333         break;
 334       case 's':
 335         set_datestr = optarg;
 336         set_date = true;
 337         break;
 338       case 'u':
 339         /* POSIX says that `date -u' is equivalent to setting the TZ
 340            environment variable, so this option should do nothing other
 341            than setting TZ.  */
 342         if (putenv ("TZ=UTC0") != 0)
 343           xalloc_die ();
 344         TZSET;
 345         break;
 346       case_GETOPT_HELP_CHAR;
 347       case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 348       default:
 349         usage (EXIT_FAILURE);
 350       }
 351
 352   n_args = argc - optind;
 353
 354   option_specified_date = ((datestr ? 1 : 0)
 355                            + (batch_file ? 1 : 0)
 356                            + (reference ? 1 : 0));
 357
 358   if (option_specified_date > 1)
 359     {
 360       error (0, 0,
 361         _("the options to specify dates for printing are mutually exclusive"));
 362       usage (EXIT_FAILURE);
 363     }
 364
 365   if (set_date && option_specified_date)
 366     {
 367       error (0, 0,
 368           _("the options to print and set the time may not be used together"));
 369       usage (EXIT_FAILURE);
 370     }
 371
 372   if (n_args > 1)
 373     {
 374       error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
 375       usage (EXIT_FAILURE);
 376     }
 377
 378   if ((set_date || option_specified_date)
 379       && n_args == 1 && argv[optind][0] != '+')
 380     {
 381       error (0, 0, _("\
 382 the argument `%s' lacks a leading `+';\n\
 383 When using an option to specify date(s), any non-option\n\
 384 argument must be a format string beginning with `+'."),
 385              argv[optind]);
 386       usage (EXIT_FAILURE);
 387     }
 388
 389   /* Simply ignore --rfc-2822 if specified when setting the date.  */
 390   if (rfc_format && !set_date && n_args > 0)
 391     {
 392       error (0, 0,
 393              _("a format string may not be specified when using\
 394  the --rfc-2822 (-R) option"));
 395       usage (EXIT_FAILURE);
 396     }
 397
 398   if (set_date)
 399     datestr = set_datestr;
 400
 401   if (batch_file != NULL)
 402     ok = batch_convert (batch_file, (n_args == 1 ? argv[optind] + 1 : NULL));
 403   else
 404     {
 405       bool valid_date = true;
 406       ok = true;
 407
 408       if (!option_specified_date && !set_date)
 409         {
 410           if (n_args == 1 && argv[optind][0] != '+')
 411             {
 412               /* Prepare to set system clock to the specified date/time
 413                  given in the POSIX-format.  */
 414               set_date = true;
 415               datestr = argv[optind];
 416               valid_date = posixtime (&when.tv_sec,
 417                                       datestr,
 418                                       (PDS_TRAILING_YEAR
 419                                        | PDS_CENTURY | PDS_SECONDS));
 420               when.tv_nsec = 0; /* FIXME: posixtime should set this.  */
 421               format = NULL;
 422             }
 423           else
 424             {
 425               /* Prepare to print the current date/time.  */
 426               datestr = _("undefined");
 427               if (gettime (&when) != 0)
 428                 error (EXIT_FAILURE, errno, _("cannot get time of day"));
 429               format = (n_args == 1 ? argv[optind] + 1 : NULL);
 430             }
 431         }
 432       else
 433         {
 434           /* (option_specified_date || set_date) */
 435           if (reference != NULL)
 436             {
 437               if (stat (reference, &refstats))
 438                 error (EXIT_FAILURE, errno, "%s", reference);
 439               when.tv_sec = refstats.st_mtime;
 440               when.tv_nsec = TIMESPEC_NS (refstats.st_mtim);
 441             }
 442           else
 443             {
 444               valid_date = get_date (&when, datestr, NULL);
 445             }
 446
 447           format = (n_args == 1 ? argv[optind] + 1 : NULL);
 448         }
 449
 450       if (! valid_date)
 451         error (EXIT_FAILURE, 0, _("invalid date `%s'"), datestr);
 452
 453       if (set_date)
 454         {
 455           /* Set the system clock to the specified date, then regardless of
 456              the success of that operation, format and print that date.  */
 457           if (settime (&when) != 0)
 458             {
 459               error (0, errno, _("cannot set date"));
 460               ok = false;
 461             }
 462         }
 463
 464       ok &= show_date (format, when);
 465     }
 466
 467   exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);
 468 }
 469
 470 /* Display the date and/or time in WHEN according to the format specified
 471    in FORMAT, followed by a newline.  If FORMAT is NULL, use the
 472    standard output format (ctime style but with a timezone inserted).
 473    Return true if successful.  */
 474
 475 static bool
 476 show_date (const char *format, struct timespec when)
 477 {
 478   struct tm *tm;
 479   char *out = NULL;
 480   size_t out_length = 0;
 481   /* ISO 8601 formats.  See below regarding %z */
 482   static char const * const iso_format_string[] =
 483   {
 484     "%Y-%m-%d",
 485     "%Y-%m-%dT%H%z",
 486     "%Y-%m-%dT%H:%M%z",
 487     "%Y-%m-%dT%H:%M:%S%z",
 488     "%Y-%m-%dT%H:%M:%S,%N%z"
 489   };
 490
 491   if (format == NULL)
 492     {
 493       if (rfc_format)
 494         format = "%a, %d %b %Y %H:%M:%S %z";
 495       else if (iso_8601_format)
 496         format = iso_format_string[iso_8601_format - 1];
 497       else
 498         {
 499           char *date_fmt = DATE_FMT_LANGINFO ();
 500           /* Do not wrap the following literal format string with _(...).
 501              For example, suppose LC_ALL is unset, LC_TIME="POSIX",
 502              and LANG="ko_KR".  In that case, POSIX says that LC_TIME
 503              determines the format and contents of date and time strings
 504              written by date, which means "date" must generate output
 505              using the POSIX locale; but adding _() would cause "date"
 506              to use a Korean translation of the format.  */
 507           format = *date_fmt ? date_fmt : "%a %b %e %H:%M:%S %Z %Y";
 508         }
 509     }
 510   else if (*format == '\0')
 511     {
 512       printf ("\n");
 513       return true;
 514     }
 515
 516   tm = localtime (&when.tv_sec);
 517   if (! tm)
 518     {
 519       char buf[INT_BUFSIZE_BOUND (intmax_t)];
 520       error (0, 0, _("time %s is out of range"),
 521              (TYPE_SIGNED (time_t)
 522               ? imaxtostr (when.tv_sec, buf)
 523               : umaxtostr (when.tv_sec, buf)));
 524       puts (buf);
 525       return false;
 526     }
 527
 528   while (1)
 529     {
 530       bool done;
 531       out = x2nrealloc (out, &out_length, sizeof *out);
 532
 533       /* Mark the first byte of the buffer so we can detect the case
 534          of nstrftime producing an empty string.  Otherwise, this loop
 535          would not terminate when date was invoked like this
 536          `LANG=de date +%p' on a system with good language support.  */
 537       out[0] = '\1';
 538
 539       if (rfc_format)
 540         setlocale (LC_ALL, "C");
 541
 542       done = (nstrftime (out, out_length, format, tm, 0, when.tv_nsec)
 543               || out[0] == '\0');
 544
 545       if (rfc_format)
 546         setlocale (LC_ALL, "");
 547
 548       if (done)
 549         break;
 550     }
 551
 552   printf ("%s\n", out);
 553   free (out);
 554   return true;
 555 }