src/date.c

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