src/date.c

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