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-(2)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   day of week (1..7);  1 represents Monday\n\
 170   %%U   week number of year with Sunday as first day of week (00..53)\n\
 171   %%V   week number of year with Monday as first day of week (01..53)\n\
 172   %%w   day of week (0..6);  0 represents Sunday\n\
 173   %%W   week number of year with Monday as first day of week (00..53)\n\
 174   %%x   locale's date representation (mm/dd/yy)\n\
 175   %%X   locale's time representation (%%H:%%M:%%S)\n\
 176   %%y   last two digits of year (00..99)\n\
 177   %%Y   year (1970...)\n\
 178   %%z   RFC-822 style numeric timezone (-0500) (a nonstandard extension)\n\
 179   %%Z   time zone (e.g., EDT), or nothing if no time zone is determinable\n\
 180 \n\
 181 By default, date pads numeric fields with zeroes.  GNU date recognizes\n\
 182 the following modifiers between `%%' and a numeric directive.\n\
 183 \n\
 184   `-' (hyphen) do not pad the field\n\
 185   `_' (underscore) pad the field with spaces\n\
 186 "));
 187       puts (_("\nReport bugs to <bug-sh-utils@gnu.org>."));
 188     }
 189   exit (status);
 190 }
 191
 192 /* Parse each line in INPUT_FILENAME as with --date and display each
 193    resulting time and date.  If the file cannot be opened, tell why
 194    then exit.  Issue a diagnostic for any lines that cannot be parsed.
 195    If any line cannot be parsed, return nonzero;  otherwise return zero.  */
 196
 197 static int
 198 batch_convert (const char *input_filename, const char *format)
 199 {
 200   int status;
 201   FILE *in_stream;
 202   char *line;
 203   int line_length;
 204   size_t buflen;
 205   time_t when;
 206
 207   if (strcmp (input_filename, "-") == 0)
 208     {
 209       input_filename = _("standard input");
 210       in_stream = stdin;
 211     }
 212   else
 213     {
 214       in_stream = fopen (input_filename, "r");
 215       if (in_stream == NULL)
 216         {
 217           error (1, errno, "`%s'", input_filename);
 218         }
 219     }
 220
 221   line = NULL;
 222   buflen = 0;
 223   status = 0;
 224   while (1)
 225     {
 226       line_length = getline (&line, &buflen, in_stream);
 227       if (line_length < 0)
 228         {
 229           /* FIXME: detect/handle error here.  */
 230           break;
 231         }
 232
 233       when = get_date (line, NULL);
 234
 235       if (when == -1)
 236         {
 237           if (line[line_length - 1] == '\n')
 238             line[line_length - 1] = '\0';
 239           error (0, 0, _("invalid date `%s'"), line);
 240           status = 1;
 241         }
 242       else
 243         {
 244           show_date (format, when);
 245         }
 246     }
 247
 248   if (fclose (in_stream) == EOF)
 249     error (2, errno, "`%s'", input_filename);
 250
 251   if (line != NULL)
 252     free (line);
 253
 254   return status;
 255 }
 256
 257 int
 258 main (int argc, char **argv)
 259 {
 260   int optc;
 261   const char *datestr = NULL;
 262   const char *set_datestr = NULL;
 263   time_t when;
 264   int set_date = 0;
 265   char *format;
 266   char *batch_file = NULL;
 267   char *reference = NULL;
 268   struct stat refstats;
 269   int n_args;
 270   int status;
 271   int option_specified_date;
 272
 273   program_name = argv[0];
 274   setlocale (LC_ALL, "");
 275   bindtextdomain (PACKAGE, LOCALEDIR);
 276   textdomain (PACKAGE);
 277
 278   close_stdout_set_status (2);
 279   atexit (close_stdout);
 280
 281   while ((optc = getopt_long (argc, argv, "d:f:I::r:Rs:u", long_options, NULL))
 282          != -1)
 283     switch (optc)
 284       {
 285       case 0:
 286         break;
 287       case 'd':
 288         datestr = optarg;
 289         break;
 290       case 'f':
 291         batch_file = optarg;
 292         break;
 293       case 'I':
 294         iso_8601_format = (optarg
 295                            ? XARGMATCH ("--iso-8601", optarg,
 296                                         time_spec_string, time_spec)
 297                            : TIME_SPEC_DATE);
 298         break;
 299       case 'r':
 300         reference = optarg;
 301         break;
 302       case 'R':
 303         rfc_format = 1;
 304         break;
 305       case 's':
 306         set_datestr = optarg;
 307         set_date = 1;
 308         break;
 309       case 'u':
 310         /* POSIX.2 says that `date -u' is equivalent to setting the TZ
 311            environment variable, so this option should do nothing other
 312            than setting TZ.  */
 313         if (putenv ("TZ=UTC0") != 0)
 314           xalloc_die ();
 315         TZSET;
 316         break;
 317       case_GETOPT_HELP_CHAR;
 318       case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 319       default:
 320         usage (1);
 321       }
 322
 323   n_args = argc - optind;
 324
 325   option_specified_date = ((datestr ? 1 : 0)
 326                            + (batch_file ? 1 : 0)
 327                            + (reference ? 1 : 0));
 328
 329   if (option_specified_date > 1)
 330     {
 331       error (0, 0,
 332         _("the options to specify dates for printing are mutually exclusive"));
 333       usage (1);
 334     }
 335
 336   if (set_date && option_specified_date)
 337     {
 338       error (0, 0,
 339           _("the options to print and set the time may not be used together"));
 340       usage (1);
 341     }
 342
 343   if (n_args > 1)
 344     {
 345       error (0, 0, _("too many non-option arguments: %s%s"),
 346              argv[optind + 1], n_args == 2 ? "" : " ...");
 347       usage (1);
 348     }
 349
 350   if ((set_date || option_specified_date)
 351       && n_args == 1 && argv[optind][0] != '+')
 352     {
 353       error (0, 0, _("\
 354 the argument `%s' lacks a leading `+';\n\
 355 When using an option to specify date(s), any non-option\n\
 356 argument must be a format string beginning with `+'."),
 357              argv[optind]);
 358       usage (1);
 359     }
 360
 361   /* Simply ignore --rfc-822 if specified when setting the date.  */
 362   if (rfc_format && !set_date && n_args > 0)
 363     {
 364       error (0, 0,
 365              _("a format string may not be specified when using\
 366  the --rfc-822 (-R) option"));
 367       usage (1);
 368     }
 369
 370   if (set_date)
 371     datestr = set_datestr;
 372
 373   if (batch_file != NULL)
 374     {
 375       status = batch_convert (batch_file,
 376                               (n_args == 1 ? argv[optind] + 1 : NULL));
 377     }
 378   else
 379     {
 380       status = 0;
 381
 382       if (!option_specified_date && !set_date)
 383         {
 384           if (n_args == 1 && argv[optind][0] != '+')
 385             {
 386               /* Prepare to set system clock to the specified date/time
 387                  given in the POSIX-format.  */
 388               set_date = 1;
 389               datestr = argv[optind];
 390               when = posixtime (datestr,
 391                                 PDS_TRAILING_YEAR | PDS_CENTURY | PDS_SECONDS);
 392               format = NULL;
 393             }
 394           else
 395             {
 396               /* Prepare to print the current date/time.  */
 397               datestr = _("undefined");
 398               time (&when);
 399               format = (n_args == 1 ? argv[optind] + 1 : NULL);
 400             }
 401         }
 402       else
 403         {
 404           /* (option_specified_date || set_date) */
 405           if (reference != NULL)
 406             {
 407               if (stat (reference, &refstats))
 408                 error (1, errno, "%s", reference);
 409               when = refstats.st_mtime;
 410             }
 411           else
 412             {
 413               when = get_date (datestr, NULL);
 414             }
 415
 416           format = (n_args == 1 ? argv[optind] + 1 : NULL);
 417         }
 418
 419       if (when == -1)
 420         error (1, 0, _("invalid date `%s'"), datestr);
 421
 422       if (set_date)
 423         {
 424           /* Set the system clock to the specified date, then regardless of
 425              the success of that operation, format and print that date.  */
 426           if (stime (&when) == -1)
 427             {
 428               error (0, errno, _("cannot set date"));
 429               status = 1;
 430             }
 431         }
 432
 433       show_date (format, when);
 434     }
 435
 436   exit (status);
 437 }
 438
 439 /* Display the date and/or time in WHEN according to the format specified
 440    in FORMAT, followed by a newline.  If FORMAT is NULL, use the
 441    standard output format (ctime style but with a timezone inserted). */
 442
 443 static void
 444 show_date (const char *format, time_t when)
 445 {
 446   struct tm *tm;
 447   char *out = NULL;
 448   size_t out_length = 0;
 449   /* ISO 8601 formats.  See below regarding %z */
 450   static char const * const iso_format_string[] =
 451   {
 452     "%Y-%m-%d",
 453     "%Y-%m-%dT%H%z",
 454     "%Y-%m-%dT%H:%M%z",
 455     "%Y-%m-%dT%H:%M:%S%z"
 456   };
 457
 458   tm = localtime (&when);
 459
 460   if (format == NULL)
 461     {
 462       /* Print the date in the default format.  Vanilla ANSI C strftime
 463          doesn't support %e, but POSIX requires it.  If you don't use
 464          a GNU strftime, make sure yours supports %e.
 465          If you are not using GNU strftime, you want to change %z
 466          in the RFC format to %Z; this gives, however, an invalid
 467          RFC time format outside the continental United States and GMT. */
 468
 469       if (rfc_format)
 470         format = "%a, %d %b %Y %H:%M:%S %z";
 471       else if (iso_8601_format)
 472         format = iso_format_string[iso_8601_format - 1];
 473       else
 474         {
 475           char *date_fmt = DATE_FMT_LANGINFO ();
 476           /* Do not wrap the following literal format string with _(...).
 477              For example, suppose LC_ALL is unset, LC_TIME="POSIX",
 478              and LANG="ko_KR".  In that case, POSIX.2 says that LC_TIME
 479              determines the format and contents of date and time strings
 480              written by date, which means "date" must generate output
 481              using the POSIX locale; but adding _() would cause "date"
 482              to use a Korean translation of the format.  */
 483           format = *date_fmt ? date_fmt : "%a %b %e %H:%M:%S %Z %Y";
 484         }
 485     }
 486   else if (*format == '\0')
 487     {
 488       printf ("\n");
 489       return;
 490     }
 491
 492   while (1)
 493     {
 494       int done;
 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       if (rfc_format)
 505         setlocale (LC_ALL, "C");
 506
 507       done = (strftime (out, out_length, format, tm) || out[0] == '\0');
 508
 509       if (rfc_format)
 510         setlocale (LC_ALL, "");
 511
 512       if (done)
 513         break;
 514     }
 515
 516   printf ("%s\n", out);
 517   free (out);
 518 }