2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
10 #include <afsconfig.h>
11 #include <afs/param.h>
22 /* some date parsing routines */
29 static char *day[] = {
39 /* free token list returned by parseLine */
41 LocalFreeTokens(struct token *alist)
44 for (; alist; alist = nlist) {
55 if (x == 0 || x == ' ' || x == '\t' || x == '\n')
62 LocalParseLine(char *aline, struct token **alist)
67 struct token *first, *last;
71 inToken = 0; /* not copying token chars at start */
76 if (tc == 0 || space(tc)) { /* terminating null gets us in here, too */
78 inToken = 0; /* end of this token */
80 ttok = malloc(sizeof(struct token));
82 ttok->key = strdup(tbuffer);
92 /* an alpha character */
97 if (tptr - tbuffer >= sizeof(tbuffer))
98 return -1; /* token too long */
102 /* last token flushed 'cause space(0) --> true */
111 /* keyword database for periodic date parsing */
112 static struct ptemp {
124 "sunday", 0x10000,}, {
125 "monday", 0x10001,}, {
126 "tuesday", 0x10002,}, {
127 "wednesday", 0x10003,}, {
128 "thursday", 0x10004,}, {
130 "friday", 0x10005,}, {
131 "saturday", 0x10006,}, {
141 * atime - time in seconds (Unix std)
143 * return value - ptr to time in text form. Ptr is to a static string.
147 ktime_DateOf(afs_int32 atime)
149 static char tbuffer[30];
155 tbuffer[24] = 0; /* get rid of new line */
157 strcpy(tbuffer, "BAD TIME");
162 * parse 12:33:12 or 12:33 or 12 into ktime structure
164 * astr - ptr to string to be parsed
165 * ak - ptr to struct for return value.
167 * 0 - ak holds parsed time.
168 * -1 - error in format
172 ParseTime(struct ktime *ak, char *astr)
179 field = 0; /* 0=hour, 1=min, 2=sec */
182 ak->mask |= (KTIME_HOUR | KTIME_MIN | KTIME_SEC);
185 if (tc == 0 || tc == ':') {
197 } else if (!isdigit(tc))
198 return -1; /* syntax error */
205 if (ak->hour >= 24 || ak->min >= 60 || ak->sec >= 60)
211 ktime_Str2int32(char *astr)
215 memset(&tk, 0, sizeof(tk));
216 if (ParseTime(&tk, astr))
217 return (-1); /* syntax error */
219 return ((tk.hour * 60 + tk.min) * 60 + tk.sec);
222 /* ktime_ParsePeriodic
223 * Parses periodic date of form
224 * now | never | at [time spec] | every [time spec]
225 * where [time spec] is a ktime string.
227 * adate - string to be parsed
228 * ak - ptr to structure for returned ktime
230 * 0 - parsed ktime in ak
231 * -1 - specification error
234 /* -1 means error, 0 means now, otherwise returns time of next event */
236 ktime_ParsePeriodic(char *adate, struct ktime *ak)
242 memset(ak, 0, sizeof(*ak));
243 code = LocalParseLine(adate, &tt);
246 for (; tt; tt = tt->next) {
247 /* look at each token */
248 if (strcmp(tt->key, "now") == 0) {
249 ak->mask |= KTIME_NOW;
252 if (strcmp(tt->key, "never") == 0) {
253 ak->mask |= KTIME_NEVER;
256 if (strcmp(tt->key, "at") == 0)
258 if (strcmp(tt->key, "every") == 0)
260 if (isdigit(tt->key[0])) {
262 code = ParseTime(ak, tt->key);
269 /* otherwise use keyword table */
270 for (tp = ptkeys;; tp++) {
271 if (tp->key == NULL) {
275 if (strcmp(tp->key, tt->key) == 0)
278 /* now look at tp->value to see what we've got */
279 if ((tp->value >> 16) == 1) {
281 ak->mask |= KTIME_DAY;
282 ak->day = tp->value & 0xff;
284 if ((tp->value >> 16) == 2) {
286 if ((tp->value & 0xff) == 1) {
288 if (!(ak->mask & KTIME_HOUR)) {
295 } else if (ak->hour != 12) {
300 /* am is almost a noop, except that we map 12:01 am to 0:01 */
315 /* ktime_DisplayString
316 * Display ktime structure as English that could go into the ktime parser
318 * aparm - ktime to be converted to string
319 * astring - ptr to string, for the result
321 * 0 - astring contains ktime string.
324 ktime_DisplayString(struct ktime *aparm, char *astring)
328 if (aparm->mask & KTIME_NEVER) {
329 strcpy(astring, "never");
331 } else if (aparm->mask & KTIME_NOW) {
332 strcpy(astring, "now");
335 strcpy(astring, "at");
336 if (aparm->mask & KTIME_DAY) {
337 strcat(astring, " ");
338 strcat(astring, day[aparm->day]);
340 if (aparm->mask & KTIME_HOUR) {
341 if (aparm->hour > 12)
342 sprintf(tempString, " %d", aparm->hour - 12);
343 else if (aparm->hour == 0)
344 strcpy(tempString, " 12");
346 sprintf(tempString, " %d", aparm->hour);
347 strcat(astring, tempString);
349 if (aparm->mask & KTIME_MIN) {
350 sprintf(tempString, ":%02d", aparm->min);
351 strcat(astring, tempString);
353 if ((aparm->mask & KTIME_SEC) && aparm->sec != 0) {
354 sprintf(tempString, ":%02d", aparm->sec);
355 strcat(astring, tempString);
357 if (aparm->mask & KTIME_HOUR) {
358 if (aparm->hour >= 12)
359 strcat(astring, " pm");
361 strcat(astring, " am");
367 /* get next time that matches ktime structure after time afrom */
369 ktime_next(struct ktime * aktime, afs_int32 afrom)
371 /* try by guessing from now */
373 time_t start; /* time to start looking */
374 time_t probe; /* a placeholder to use for advancing day to day */
375 time_t time_next; /* actual UTC time of probe, with time of day set */
377 struct ktime_date tdate;
379 start = afrom + time(0); /* time to start search */
380 tmask = aktime->mask;
382 /* handle some special cases */
383 if (tmask & KTIME_NEVER)
384 return KTIME_NEVERTIME;
385 if (tmask & KTIME_NOW)
386 return KTIME_NOWTIME;
388 /* Use probe to fill in members of *tsp. Add 23 hours each iteration until
389 * time_next is correct. Only add 23 hrs to avoid skipping spring
390 * daylight savings time day */
391 for (probe = start;; probe += (23 * 3600)) {
392 tsp = localtime(&probe); /* find out what UTC time "probe" is */
394 return KTIME_NEVERTIME;
396 tdate.year = tsp->tm_year;
397 tdate.month = tsp->tm_mon + 1;
398 tdate.day = tsp->tm_mday;
400 KTIMEDATE_YEAR | KTIMEDATE_MONTH | KTIMEDATE_DAY | KTIMEDATE_HOUR
401 | KTIMEDATE_MIN | KTIMEDATE_SEC;
402 tdate.hour = aktime->hour; /* edit in our changes */
403 tdate.min = aktime->min;
404 tdate.sec = aktime->sec;
405 time_next = ktime_InterpretDate(&tdate); /* Convert back to UTC time */
406 if (time_next < start)
407 continue; /* "probe" time is already past */
408 if ((tmask & KTIME_DAY) == 0) /* don't care about day, we're done */
411 tsp = localtime(&time_next);
413 return KTIME_NEVERTIME;
414 if (tsp->tm_wday == aktime->day)
415 break; /* day matches, we're done */
421 /* compare date in both formats, and return as in strcmp */
424 KTimeCmp(struct ktime *aktime, struct tm *atm)
428 /* don't compare day of the week, since we can't tell the
429 * order in a cyclical set. Caller must check for equality, if
431 tmask = aktime->mask;
432 if (tmask & KTIME_HOUR) {
433 if (aktime->hour > atm->tm_hour)
435 if (aktime->hour < atm->tm_hour)
438 if (tmask & KTIME_MIN) {
439 if (aktime->min > atm->tm_min)
441 if (aktime->min < atm->tm_min)
444 if (tmask & KTIME_SEC) {
445 if (aktime->sec > atm->tm_sec)
447 if (aktime->sec < atm->tm_sec)
454 /* compare date in both formats, and return as in strcmp */
456 KDateCmp(struct ktime_date *akdate, struct tm *atm)
458 if (akdate->year > atm->tm_year)
460 if (akdate->year < atm->tm_year)
462 if (akdate->month > atm->tm_mon)
464 if (akdate->month < atm->tm_mon)
466 if (akdate->day > atm->tm_mday)
468 if (akdate->day < atm->tm_mday)
470 if (akdate->mask & KTIMEDATE_HOUR) {
471 if (akdate->hour > atm->tm_hour)
473 if (akdate->hour < atm->tm_hour)
476 if (akdate->mask & KTIMEDATE_MIN) {
477 if (akdate->min > atm->tm_min)
479 if (akdate->min < atm->tm_min)
482 if (akdate->mask & KTIMEDATE_SEC) {
483 if (akdate->sec > atm->tm_sec)
485 if (akdate->sec < atm->tm_sec)
492 * parse date string into ktime_date structure
494 * adate - string to be parsed
495 * akdate - ptr to ktime_date for result
497 * 0 - akdate contains converted date
498 * -1 - parsing failure
502 ktime_ParseDate(char *adate, struct ktime_date *akdate)
505 afs_int32 month, day2, year, hour, min, sec;
509 lcstring(never, adate, sizeof(never));
510 if (strcmp(never, "never") == 0)
511 akdate->mask = KTIMEDATE_NEVER;
512 else if (strcmp(never, "now") == 0)
513 akdate->mask = KTIMEDATE_NOW;
519 /* Old ambiguous mm/dd/yy hh:mm:ss format */
522 sscanf(adate, "%d / %d / %d %d : %d : %d%1s", &month, &day2, &year,
523 &hour, &min, &sec, &c[0]);
527 sscanf(adate, "%d / %d / %d %d : %d%1s", &month, &day2, &year,
532 sscanf(adate, "%d / %d / %d%1s", &month, &day2, &year, &c[0]);
539 /* New ISO 8601 (subset) format */
542 hour = min = sec = 0;
544 sscanf(adate, "%d-%d-%d %d:%d:%d%1s", &year, &month, &day2,
545 &hour, &min, &sec, c);
546 if (code != 3 && code != 5 && code != 6)
553 if ((year < 0) || (month < 1) || (month > 12) || (day2 < 1) || (day2 > 31) || /* more or less */
554 (hour < 0) || (hour > 23) || (min < 0) || (min > 59) || (sec < 0)
559 year += 100; /* make 1/1/1 => Jan 1, 2001 */
560 else if (year >= 1900)
561 year -= 1900; /* allow 1/1/2001 to work */
563 return -2; /* only allow 2 or 4 digit years */
566 KTIMEDATE_YEAR | KTIMEDATE_MONTH | KTIMEDATE_DAY | KTIMEDATE_HOUR |
567 KTIMEDATE_MIN | KTIMEDATE_SEC;
570 akdate->month = month;
576 /* done successfully */
581 * Converts a ktime date string into an afs_int32
583 * adate - ktime date string
584 * aint32 - ptr to afs_int32
586 * 0 - aint32 contains converted date.
590 ktime_DateToInt32(char *adate, afs_int32 * aint32)
592 struct ktime_date tdate;
597 if (sscanf(adate, "%lu%1s", &l, c) == 1 && l > 200000000)
600 /* parse the date into a ktime_date structure */
601 code = ktime_ParseDate(adate, &tdate);
603 return code; /* failed to parse */
604 *aint32 = ktime_InterpretDate(&tdate); /* interpret as seconds since 1970 */
610 /* get useful error message to print about date input format */
612 ktime_GetDateUsage(void)
614 return "date format is '(yyyy-mm-dd | mm/dd/yy) [hh:mm]', using a 24 hour clock";
618 /* ktime_InterpretDate
619 * Converts ktime_date to an afs_int32
621 * akdate - date to be converted/interpreted
623 * returns KTIMEDATE_NEVERDATE - if never flag was set, or
624 * date converted to afs_int32.
628 ktime_InterpretDate(struct ktime_date * akdate)
635 if (akdate->mask & KTIMEDATE_NOW)
637 if (akdate->mask & KTIMEDATE_NEVER)
638 return KTIMEDATE_NEVERDATE;
640 tbit = 1 << 30; /* start off at max signed result */
641 tresult = 0; /* result to return */
643 temp = tresult + tbit; /* see if adding this bit keeps us < akdate */
644 tsp = localtime(&temp);
646 return KTIMEDATE_NEVERDATE;
648 if (KDateCmp(akdate, tsp) >= 0) {
649 /* if temp still represents earlier than date than we're searching
650 * for, add in bit as increment, otherwise use old value and look
651 * for smaller increment */
654 tbit = tbit >> 1; /* try next bit */