1 /* Copyright 1988,1990,1993,1994 by Paul Vixie
4 * Distribute freely, except: don't remove my name from the source or
5 * documentation (don't take credit for my work), mark your changes (don't
6 * get me blamed for your possible bugs), don't alter or remove this
7 * notice. May be sold if buildable source is provided to buyer. No
8 * warrantee of any kind, express or implied, is included with this
9 * software; use at your own risk, responsibility for damages (if any) to
10 * anyone resulting from the use of this software rests entirely with the
13 * Send bug reports, bug fixes, enhancements, requests, flames, etc., and
14 * I'll try to keep a version up to date. I can be reached as follows:
15 * Paul Vixie <paul@vix.com> uunet!decwrl!vixie!paul
18 #if !defined(lint) && !defined(LINT)
19 static const char rcsid[] =
23 /* vix 26jan87 [RCS'd; rest of log is in RCS file]
24 * vix 01jan87 [added line-level error recovery]
25 * vix 31dec86 [added /step to the from-to range, per bob@acornrc]
26 * vix 30dec86 [written]
33 #include <login_cap.h>
37 e_none, e_minute, e_hour, e_dom, e_month, e_dow,
38 e_cmd, e_timespec, e_username, e_group, e_mem
44 static char get_list(bitstr_t *, int, int, char *[], int, FILE *),
45 get_range(bitstr_t *, int, int, char *[], int, FILE *),
46 get_number(int *, int, char *[], int, FILE *);
47 static int set_element(bitstr_t *, int, int, int);
49 static char *ecodes[] =
84 /* return NULL if eof or syntax error occurs;
85 * otherwise return a pointer to a new entry.
88 load_entry(file, error_func, pw, envp)
90 void (*error_func)(char *);
94 /* this function reads one crontab entry -- the next -- from a file.
95 * it skips any leading blank lines, ignores comments, and returns
96 * EOF if for any reason the entry can't be read and parsed.
98 * the entry is also parsed here.
102 * minutes hours doms months dows cmd\n
103 * system crontab (/etc/crontab):
104 * minutes hours doms months dows USERNAME cmd\n
107 ecode_e ecode = e_none;
110 char cmd[MAX_COMMAND];
111 char envstr[MAX_ENVSTR];
114 Debug(DPARS, ("load_entry()...about to eat comments\n"))
122 /* ch is now the first useful character of a useful line.
123 * it may be an @special or it may be the first character
124 * of a list of minutes.
127 e = (entry *) calloc(sizeof(entry), sizeof(char));
130 warn("load_entry: calloc failed");
138 /* all of these should be flagged and load-limited; i.e.,
139 * instead of @hourly meaning "0 * * * *" it should mean
140 * "close to the front of every hour but not 'til the
141 * system load is low". Problems are: how do you know
142 * what "low" means? (save me from /etc/cron.conf!) and:
143 * how to guarantee low variance (how low is low?), which
144 * means how to we run roughly every hour -- seems like
145 * we need to keep a history or let the first hour set
146 * the schedule, which means we aren't load-limited
147 * anymore. too much for my overloaded brain. (vix, jan90)
150 Debug(DPARS, ("load_entry()...about to test shortcuts\n"))
151 ch = get_string(cmd, MAX_COMMAND, file, " \t\n");
152 if (!strcmp("reboot", cmd)) {
153 Debug(DPARS, ("load_entry()...reboot shortcut\n"))
154 e->flags |= WHEN_REBOOT;
155 } else if (!strcmp("yearly", cmd) || !strcmp("annually", cmd)){
156 Debug(DPARS, ("load_entry()...yearly shortcut\n"))
157 bit_set(e->second, 0);
158 bit_set(e->minute, 0);
161 bit_set(e->month, 0);
162 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
163 e->flags |= DOW_STAR;
164 } else if (!strcmp("monthly", cmd)) {
165 Debug(DPARS, ("load_entry()...monthly shortcut\n"))
166 bit_set(e->second, 0);
167 bit_set(e->minute, 0);
170 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
171 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
172 e->flags |= DOW_STAR;
173 } else if (!strcmp("weekly", cmd)) {
174 Debug(DPARS, ("load_entry()...weekly shortcut\n"))
175 bit_set(e->second, 0);
176 bit_set(e->minute, 0);
178 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
179 e->flags |= DOM_STAR;
180 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
182 } else if (!strcmp("daily", cmd) || !strcmp("midnight", cmd)) {
183 Debug(DPARS, ("load_entry()...daily shortcut\n"))
184 bit_set(e->second, 0);
185 bit_set(e->minute, 0);
187 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
188 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
189 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
190 } else if (!strcmp("hourly", cmd)) {
191 Debug(DPARS, ("load_entry()...hourly shortcut\n"))
192 bit_set(e->second, 0);
193 bit_set(e->minute, 0);
194 bit_nset(e->hour, 0, (LAST_HOUR-FIRST_HOUR+1));
195 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
196 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
197 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
198 } else if (!strcmp("every_minute", cmd)) {
199 Debug(DPARS, ("load_entry()...every_minute shortcut\n"))
200 bit_set(e->second, 0);
201 bit_nset(e->minute, 0, (LAST_MINUTE-FIRST_MINUTE+1));
202 bit_nset(e->hour, 0, (LAST_HOUR-FIRST_HOUR+1));
203 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
204 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
205 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
206 } else if (!strcmp("every_second", cmd)) {
207 Debug(DPARS, ("load_entry()...every_second shortcut\n"))
209 bit_nset(e->second, 0, (LAST_SECOND-FIRST_SECOND+1));
210 bit_nset(e->minute, 0, (LAST_MINUTE-FIRST_MINUTE+1));
211 bit_nset(e->hour, 0, (LAST_HOUR-FIRST_HOUR+1));
212 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
213 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
214 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
215 } else if (*cmd != '\0' &&
216 (interval = strtol(cmd, &endptr, 10)) > 0 &&
218 Debug(DPARS, ("load_entry()... %ld seconds "
219 "since last run\n", interval))
220 e->interval = interval;
226 /* Advance past whitespace between shortcut and
229 Skip_Blanks(ch, file);
235 Debug(DPARS, ("load_entry()...about to parse numerics\n"))
236 bit_set(e->second, 0);
238 ch = get_list(e->minute, FIRST_MINUTE, LAST_MINUTE,
248 ch = get_list(e->hour, FIRST_HOUR, LAST_HOUR,
255 /* DOM (days of month)
259 e->flags |= DOM_STAR;
260 ch = get_list(e->dom, FIRST_DOM, LAST_DOM,
270 ch = get_list(e->month, FIRST_MONTH, LAST_MONTH,
271 MonthNames, ch, file);
277 /* DOW (days of week)
281 e->flags |= DOW_STAR;
282 ch = get_list(e->dow, FIRST_DOW, LAST_DOW,
290 /* make sundays equivalent */
291 if (bit_test(e->dow, 0) || bit_test(e->dow, 7)) {
296 /* ch is the first character of a command, or a username */
297 unget_char(ch, file);
300 char *username = cmd; /* temp buffer */
307 Debug(DPARS, ("load_entry()...about to parse username\n"))
308 ch = get_string(username, MAX_COMMAND, file, " \t");
310 Debug(DPARS, ("load_entry()...got %s\n",username))
317 if ((s = strrchr(username, '/')) != NULL) {
319 e->class = strdup(s + 1);
320 if (e->class == NULL)
321 warn("strdup(\"%s\")", s + 1);
323 e->class = strdup(RESOURCE_RC);
324 if (e->class == NULL)
325 warn("strdup(\"%s\")", RESOURCE_RC);
327 if (e->class == NULL) {
331 if ((lc = login_getclass(e->class)) == NULL) {
338 if ((s = strrchr(username, ':')) != NULL) {
340 if ((grp = getgrnam(s + 1)) == NULL) {
346 pw = getpwnam(username);
352 pw->pw_gid = grp->gr_gid;
353 Debug(DPARS, ("load_entry()...uid %d, gid %d\n",pw->pw_uid,pw->pw_gid))
355 Debug(DPARS, ("load_entry()...class %s\n",e->class))
359 #ifndef PAM /* PAM takes care of account expiration by itself */
360 if (pw->pw_expire && time(NULL) >= pw->pw_expire) {
369 /* copy and fix up environment. some variables are just defaults and
370 * others are overrides.
372 e->envp = env_copy(envp);
373 if (e->envp == NULL) {
378 if (!env_get("SHELL", e->envp)) {
380 sprintf(envstr, "SHELL=%s", _PATH_BSHELL);
381 e->envp = env_set(e->envp, envstr);
382 if (e->envp == NULL) {
383 warn("env_set(%s)", envstr);
389 if (!env_get("HOME", e->envp)) {
391 sprintf(envstr, "HOME=%s", pw->pw_dir);
392 e->envp = env_set(e->envp, envstr);
393 if (e->envp == NULL) {
394 warn("env_set(%s)", envstr);
400 if (!env_get("PATH", e->envp)) {
402 sprintf(envstr, "PATH=%s", _PATH_DEFPATH);
403 e->envp = env_set(e->envp, envstr);
404 if (e->envp == NULL) {
405 warn("env_set(%s)", envstr);
412 sprintf(envstr, "%s=%s", "LOGNAME", pw->pw_name);
413 e->envp = env_set(e->envp, envstr);
414 if (e->envp == NULL) {
415 warn("env_set(%s)", envstr);
422 sprintf(envstr, "%s=%s", "USER", pw->pw_name);
423 e->envp = env_set(e->envp, envstr);
424 if (e->envp == NULL) {
425 warn("env_set(%s)", envstr);
432 Debug(DPARS, ("load_entry()...about to parse command\n"))
434 /* Everything up to the next \n or EOF is part of the command...
435 * too bad we don't know in advance how long it will be, since we
436 * need to malloc a string for it... so, we limit it to MAX_COMMAND.
437 * XXX - should use realloc().
439 ch = get_string(cmd, MAX_COMMAND, file, "\n");
441 /* a file without a \n before the EOF is rude, so we'll complain...
448 /* got the command in the 'cmd' string; save it in *e.
450 e->cmd = strdup(cmd);
451 if (e->cmd == NULL) {
452 warn("strdup(\"%s\")", cmd);
456 Debug(DPARS, ("load_entry()...returning successfully\n"))
458 /* success, fini, return pointer to the entry we just created...
464 if (ecode != e_none && error_func)
465 (*error_func)(ecodes[(int)ecode]);
466 while (ch != EOF && ch != '\n')
473 get_list(bits, low, high, names, ch, file)
474 bitstr_t *bits; /* one bit per flag, default=FALSE */
475 int low, high; /* bounds, impl. offset for bitstr */
476 char *names[]; /* NULL or *[] of names for these elements */
477 int ch; /* current character being processed */
478 FILE *file; /* file being read */
482 /* we know that we point to a non-blank character here;
483 * must do a Skip_Blanks before we exit, so that the
484 * next call (or the code that picks up the cmd) can
485 * assume the same thing.
488 Debug(DPARS|DEXT, ("get_list()...entered\n"))
490 /* list = range {"," range}
493 /* clear the bit string, since the default is 'off'.
495 bit_nclear(bits, 0, (high-low+1));
497 /* process all ranges
501 ch = get_range(bits, low, high, names, ch, file);
508 /* exiting. skip to some blanks, then skip over the blanks.
510 Skip_Nonblanks(ch, file)
511 Skip_Blanks(ch, file)
513 Debug(DPARS|DEXT, ("get_list()...exiting w/ %02x\n", ch))
520 get_range(bits, low, high, names, ch, file)
521 bitstr_t *bits; /* one bit per flag, default=FALSE */
522 int low, high; /* bounds, impl. offset for bitstr */
523 char *names[]; /* NULL or names of elements */
524 int ch; /* current character being processed */
525 FILE *file; /* file being read */
527 /* range = number | number "-" number [ "/" number ]
531 auto int num1, num2, num3;
533 Debug(DPARS|DEXT, ("get_range()...entering, exit won't show\n"))
536 /* '*' means "first-last" but can still be modified by /step
544 if (EOF == (ch = get_number(&num1, low, names, ch, file)))
549 else if (ch != '-') {
550 /* not a range, it's a single number.
552 if (EOF == set_element(bits, low, high, num1))
562 /* get the number following the dash
564 ch = get_number(&num2, low, names, ch, file);
570 /* check for step size
579 /* get the step size -- note: we don't pass the
580 * names here, because the number is not an
581 * element id, it's a step size. 'low' is
582 * sent as a 0 since there is no offset either.
584 ch = get_number(&num3, 0, PPC_NULL, ch, file);
585 if (ch == EOF || num3 == 0)
588 /* no step. default==1.
593 /* range. set all elements from num1 to num2, stepping
594 * by num3. (the step is a downward-compatible extension
595 * proposed conceptually by bob@acornrc, syntactically
596 * designed then implmented by paul vixie).
598 for (i = num1; i <= num2; i += num3)
599 if (EOF == set_element(bits, low, high, i))
607 get_number(numptr, low, names, ch, file)
608 int *numptr; /* where does the result go? */
609 int low; /* offset applied to result if symbolic enum used */
610 char *names[]; /* symbolic names, if any, for enums */
611 int ch; /* current character */
612 FILE *file; /* source */
614 char temp[MAX_TEMPSTR], *pc;
615 int len, i, all_digits;
617 /* collect alphanumerics into our fixed-size temp array
622 while (isalnum(ch)) {
623 if (++len >= MAX_TEMPSTR)
637 /* try to find the name in the name list
640 for (i = 0; names[i] != NULL; i++) {
642 ("get_num, compare(%s,%s)\n", names[i], temp))
643 if (!strcasecmp(names[i], temp)) {
650 /* no name list specified, or there is one and our string isn't
651 * in it. either way: if it's all digits, use its magnitude.
652 * otherwise, it's an error.
655 *numptr = atoi(temp);
664 set_element(bits, low, high, number)
665 bitstr_t *bits; /* one bit per flag, default=FALSE */
670 Debug(DPARS|DEXT, ("set_element(?,%d,%d,%d)\n", low, high, number))
672 if (number < low || number > high)
675 bit_set(bits, (number-low));