src/date.c

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