src/date.c

   1 /* date - print or set the system date and time
   2    Copyright (C) 1989-2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 "quote.h"
  36 #include "strftime.h"
  37 #include "xanstrftime.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", NULL
  65 };
  66 static enum Time_spec const time_spec[] =
  67 {
  68   TIME_SPEC_DATE, TIME_SPEC_HOURS, TIME_SPEC_MINUTES, TIME_SPEC_SECONDS,
  69   TIME_SPEC_NS
  70 };
  71 ARGMATCH_VERIFY (time_spec_string, time_spec);
  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 static char const short_options[] = "d:f:I::r:Rs: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   -I[TIMESPEC], --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 (e.g., Sun)\n\
 151 "), stdout);
 152       fputs (_("\
 153   %A   locale's full weekday name (e.g., Sunday)\n\
 154   %b   locale's abbreviated month name (e.g., Jan)\n\
 155   %B   locale's full month name (e.g., January)\n\
 156   %c   locale's date and time (e.g., Thu Mar  3 23:05:25 2005)\n\
 157 "), stdout);
 158       fputs (_("\
 159   %C   century; like %Y, except omit last two digits (e.g., 21)\n\
 160   %d   day of month (e.g, 01)\n\
 161   %D   date; same as %m/%d/%y\n\
 162   %e   day of month, space padded; same as %_d\n\
 163 "), stdout);
 164       fputs (_("\
 165   %F   full date; same as %Y-%m-%d\n\
 166   %g   the last two digits of the year corresponding to the %V week number\n\
 167   %G   the 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 equivalent of either AM or PM; blank if not known\n\
 185   %P   like %p, but lower case\n\
 186   %r   locale's 12-hour clock time (e.g., 11:11:04 PM)\n\
 187   %R   24-hour hour and minute; same as %H:%M\n\
 188   %s   seconds since 1970-01-01 00:00:00 UTC\n\
 189 "), stdout);
 190       fputs (_("\
 191   %S   second (00..60)\n\
 192   %t   a tab\n\
 193   %T   time; same as %H:%M:%S\n\
 194   %u   day of week (1..7); 1 is 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 is 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 (e.g., 12/31/99)\n\
 204   %X   locale's time representation (e.g., 23:13:48)\n\
 205   %y   last two digits of year (00..99)\n\
 206   %Y   year\n\
 207 "), stdout);
 208       fputs (_("\
 209   %z   numeric timezone (e.g., -0400)\n\
 210   %Z   alphabetic time zone abbreviation (e.g., EDT)\n\
 211 \n\
 212 By default, date pads numeric fields with zeroes.\n\
 213 The following optional flags may follow `%':\n\
 214 \n\
 215   - (hyphen) do not pad the field\n\
 216   _ (underscore) pad with spaces\n\
 217   0 (zero) pad with zeros\n\
 218   ^ use upper case if possible\n\
 219   # use opposite case if possible\n\
 220 "), stdout);
 221       fputs (_("\
 222 \n\
 223 After any flags comes an optional field width, as a decimal number;\n\
 224 then an optional modifier, which is either\n\
 225 E to use the locale's alternate representations if available, or\n\
 226 O to use the locale's alternate numeric symbols if available.\n\
 227 "), stdout);
 228       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 229     }
 230   exit (status);
 231 }
 232
 233 /* Parse each line in INPUT_FILENAME as with --date and display each
 234    resulting time and date.  If the file cannot be opened, tell why
 235    then exit.  Issue a diagnostic for any lines that cannot be parsed.
 236    Return true if successful.  */
 237
 238 static bool
 239 batch_convert (const char *input_filename, const char *format)
 240 {
 241   bool ok;
 242   FILE *in_stream;
 243   char *line;
 244   size_t buflen;
 245   struct timespec when;
 246
 247   if (STREQ (input_filename, "-"))
 248     {
 249       input_filename = _("standard input");
 250       in_stream = stdin;
 251     }
 252   else
 253     {
 254       in_stream = fopen (input_filename, "r");
 255       if (in_stream == NULL)
 256         {
 257           error (EXIT_FAILURE, errno, "%s", quote (input_filename));
 258         }
 259     }
 260
 261   line = NULL;
 262   buflen = 0;
 263   ok = true;
 264   while (1)
 265     {
 266       ssize_t line_length = getline (&line, &buflen, in_stream);
 267       if (line_length < 0)
 268         {
 269           /* FIXME: detect/handle error here.  */
 270           break;
 271         }
 272
 273       if (! get_date (&when, line, NULL))
 274         {
 275           if (line[line_length - 1] == '\n')
 276             line[line_length - 1] = '\0';
 277           error (0, 0, _("invalid date %s"), quote (line));
 278           ok = false;
 279         }
 280       else
 281         {
 282           ok &= show_date (format, when);
 283         }
 284     }
 285
 286   if (fclose (in_stream) == EOF)
 287     error (EXIT_FAILURE, errno, "%s", quote (input_filename));
 288
 289   free (line);
 290
 291   return ok;
 292 }
 293
 294 int
 295 main (int argc, char **argv)
 296 {
 297   int optc;
 298   const char *datestr = NULL;
 299   const char *set_datestr = NULL;
 300   struct timespec when;
 301   bool set_date = false;
 302   char *format;
 303   char *batch_file = NULL;
 304   char *reference = NULL;
 305   struct stat refstats;
 306   int n_args;
 307   bool ok;
 308   int option_specified_date;
 309
 310   initialize_main (&argc, &argv);
 311   program_name = argv[0];
 312   setlocale (LC_ALL, "");
 313   bindtextdomain (PACKAGE, LOCALEDIR);
 314   textdomain (PACKAGE);
 315
 316   atexit (close_stdout);
 317
 318   while ((optc = getopt_long (argc, argv, short_options, long_options, NULL))
 319          != -1)
 320     switch (optc)
 321       {
 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 = true;
 339         break;
 340       case 's':
 341         set_datestr = optarg;
 342         set_date = true;
 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, AUTHORS);
 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, _("extra operand %s"), quote (argv[optind + 1]));
 381       usage (EXIT_FAILURE);
 382     }
 383
 384   if ((set_date || option_specified_date)
 385       && n_args == 1 && argv[optind][0] != '+')
 386     {
 387       error (0, 0, _("\
 388 the argument %s lacks a leading `+';\n\
 389 When using an option to specify date(s), any non-option\n\
 390 argument must be a format string beginning with `+'."),
 391              quote (argv[optind]));
 392       usage (EXIT_FAILURE);
 393     }
 394
 395   /* Simply ignore --rfc-2822 if specified when setting the date.  */
 396   if (rfc_format && !set_date && n_args > 0)
 397     {
 398       error (0, 0,
 399              _("a format string may not be specified when using\
 400  the --rfc-2822 (-R) option"));
 401       usage (EXIT_FAILURE);
 402     }
 403
 404   if (set_date)
 405     datestr = set_datestr;
 406
 407   if (batch_file != NULL)
 408     ok = batch_convert (batch_file, (n_args == 1 ? argv[optind] + 1 : NULL));
 409   else
 410     {
 411       bool valid_date = true;
 412       ok = true;
 413
 414       if (!option_specified_date && !set_date)
 415         {
 416           if (n_args == 1 && argv[optind][0] != '+')
 417             {
 418               /* Prepare to set system clock to the specified date/time
 419                  given in the POSIX-format.  */
 420               set_date = true;
 421               datestr = argv[optind];
 422               valid_date = posixtime (&when.tv_sec,
 423                                       datestr,
 424                                       (PDS_TRAILING_YEAR
 425                                        | PDS_CENTURY | PDS_SECONDS));
 426               when.tv_nsec = 0; /* FIXME: posixtime should set this.  */
 427               format = NULL;
 428             }
 429           else
 430             {
 431               /* Prepare to print the current date/time.  */
 432               datestr = _("undefined");
 433               gettime (&when);
 434               format = (n_args == 1 ? argv[optind] + 1 : NULL);
 435             }
 436         }
 437       else
 438         {
 439           /* (option_specified_date || set_date) */
 440           if (reference != NULL)
 441             {
 442               if (stat (reference, &refstats))
 443                 error (EXIT_FAILURE, errno, "%s", reference);
 444               when.tv_sec = refstats.st_mtime;
 445               when.tv_nsec = TIMESPEC_NS (refstats.st_mtim);
 446             }
 447           else
 448             {
 449               valid_date = get_date (&when, datestr, NULL);
 450             }
 451
 452           format = (n_args == 1 ? argv[optind] + 1 : NULL);
 453         }
 454
 455       if (! valid_date)
 456         error (EXIT_FAILURE, 0, _("invalid date %s"), quote (datestr));
 457
 458       if (set_date)
 459         {
 460           /* Set the system clock to the specified date, then regardless of
 461              the success of that operation, format and print that date.  */
 462           if (settime (&when) != 0)
 463             {
 464               error (0, errno, _("cannot set date"));
 465               ok = false;
 466             }
 467         }
 468
 469       ok &= show_date (format, when);
 470     }
 471
 472   exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);
 473 }
 474
 475 /* Display the date and/or time in WHEN according to the format specified
 476    in FORMAT, followed by a newline.  If FORMAT is NULL, use the
 477    standard output format (ctime style but with a timezone inserted).
 478    Return true if successful.  */
 479
 480 static bool
 481 show_date (const char *format, struct timespec when)
 482 {
 483   struct tm *tm;
 484   /* ISO 8601 formats.  See below regarding %z */
 485   static char const * const iso_format_string[] =
 486   {
 487     "%Y-%m-%d",
 488     "%Y-%m-%dT%H%z",
 489     "%Y-%m-%dT%H:%M%z",
 490     "%Y-%m-%dT%H:%M:%S%z",
 491     "%Y-%m-%dT%H:%M:%S,%N%z"
 492   };
 493
 494   if (format == NULL)
 495     {
 496       if (rfc_format)
 497         format = "%a, %d %b %Y %H:%M:%S %z";
 498       else if (iso_8601_format)
 499         format = iso_format_string[iso_8601_format - 1];
 500       else
 501         {
 502           char *date_fmt = DATE_FMT_LANGINFO ();
 503           /* Do not wrap the following literal format string with _(...).
 504              For example, suppose LC_ALL is unset, LC_TIME="POSIX",
 505              and LANG="ko_KR".  In that case, POSIX says that LC_TIME
 506              determines the format and contents of date and time strings
 507              written by date, which means "date" must generate output
 508              using the POSIX locale; but adding _() would cause "date"
 509              to use a Korean translation of the format.  */
 510           format = *date_fmt ? date_fmt : "%a %b %e %H:%M:%S %Z %Y";
 511         }
 512     }
 513
 514   tm = localtime (&when.tv_sec);
 515   if (! tm)
 516     {
 517       char buf[INT_BUFSIZE_BOUND (intmax_t)];
 518       error (0, 0, _("time %s is out of range"),
 519              (TYPE_SIGNED (time_t)
 520               ? imaxtostr (when.tv_sec, buf)
 521               : umaxtostr (when.tv_sec, buf)));
 522       puts (buf);
 523       return false;
 524     }
 525
 526   {
 527     char *out;
 528
 529     if (rfc_format)
 530       setlocale (LC_TIME, "C");
 531     out = xanstrftime (format, tm, 0, when.tv_nsec);
 532     if (rfc_format)
 533       setlocale (LC_TIME, "");
 534
 535     puts (out);
 536     free (out);
 537   }
 538   return true;
 539 }