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[] =
20 "$FreeBSD: src/usr.sbin/cron/lib/entry.c,v 1.9.2.5 2001/08/18 04:20:31 mikeh Exp $";
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 __P((bitstr_t *, int, int, char *[], int, FILE *)),
45 get_range __P((bitstr_t *, int, int, char *[], int, FILE *)),
46 get_number __P((int *, int, char *[], int, FILE *));
47 static int set_element __P((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)
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");
135 /* all of these should be flagged and load-limited; i.e.,
136 * instead of @hourly meaning "0 * * * *" it should mean
137 * "close to the front of every hour but not 'til the
138 * system load is low". Problems are: how do you know
139 * what "low" means? (save me from /etc/cron.conf!) and:
140 * how to guarantee low variance (how low is low?), which
141 * means how to we run roughly every hour -- seems like
142 * we need to keep a history or let the first hour set
143 * the schedule, which means we aren't load-limited
144 * anymore. too much for my overloaded brain. (vix, jan90)
147 Debug(DPARS, ("load_entry()...about to test shortcuts\n"))
148 ch = get_string(cmd, MAX_COMMAND, file, " \t\n");
149 if (!strcmp("reboot", cmd)) {
150 Debug(DPARS, ("load_entry()...reboot shortcut\n"))
151 e->flags |= WHEN_REBOOT;
152 } else if (!strcmp("yearly", cmd) || !strcmp("annually", cmd)){
153 Debug(DPARS, ("load_entry()...yearly shortcut\n"))
154 bit_set(e->minute, 0);
157 bit_set(e->month, 0);
158 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
159 e->flags |= DOW_STAR;
160 } else if (!strcmp("monthly", cmd)) {
161 Debug(DPARS, ("load_entry()...monthly shortcut\n"))
162 bit_set(e->minute, 0);
165 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
166 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
167 e->flags |= DOW_STAR;
168 } else if (!strcmp("weekly", cmd)) {
169 Debug(DPARS, ("load_entry()...weekly shortcut\n"))
170 bit_set(e->minute, 0);
172 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
173 e->flags |= DOM_STAR;
174 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
176 } else if (!strcmp("daily", cmd) || !strcmp("midnight", cmd)) {
177 Debug(DPARS, ("load_entry()...daily shortcut\n"))
178 bit_set(e->minute, 0);
180 bit_nset(e->dom, 0, (LAST_DOM-FIRST_DOM+1));
181 bit_nset(e->month, 0, (LAST_MONTH-FIRST_MONTH+1));
182 bit_nset(e->dow, 0, (LAST_DOW-FIRST_DOW+1));
183 } else if (!strcmp("hourly", cmd)) {
184 Debug(DPARS, ("load_entry()...hourly shortcut\n"))
185 bit_set(e->minute, 0);
186 bit_nset(e->hour, 0, (LAST_HOUR-FIRST_HOUR+1));
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));
194 /* Advance past whitespace between shortcut and
197 Skip_Blanks(ch, file);
203 Debug(DPARS, ("load_entry()...about to parse numerics\n"))
205 ch = get_list(e->minute, FIRST_MINUTE, LAST_MINUTE,
215 ch = get_list(e->hour, FIRST_HOUR, LAST_HOUR,
222 /* DOM (days of month)
226 e->flags |= DOM_STAR;
227 ch = get_list(e->dom, FIRST_DOM, LAST_DOM,
237 ch = get_list(e->month, FIRST_MONTH, LAST_MONTH,
238 MonthNames, ch, file);
244 /* DOW (days of week)
248 e->flags |= DOW_STAR;
249 ch = get_list(e->dow, FIRST_DOW, LAST_DOW,
257 /* make sundays equivilent */
258 if (bit_test(e->dow, 0) || bit_test(e->dow, 7)) {
263 /* ch is the first character of a command, or a username */
264 unget_char(ch, file);
267 char *username = cmd; /* temp buffer */
274 Debug(DPARS, ("load_entry()...about to parse username\n"))
275 ch = get_string(username, MAX_COMMAND, file, " \t");
277 Debug(DPARS, ("load_entry()...got %s\n",username))
284 if ((s = strrchr(username, '/')) != NULL) {
286 e->class = strdup(s + 1);
287 if (e->class == NULL)
288 warn("strdup(\"%s\")", s + 1);
290 e->class = strdup(RESOURCE_RC);
291 if (e->class == NULL)
292 warn("strdup(\"%s\")", RESOURCE_RC);
294 if (e->class == NULL) {
298 if ((lc = login_getclass(e->class)) == NULL) {
305 if ((s = strrchr(username, ':')) != NULL) {
307 if ((grp = getgrnam(s + 1)) == NULL) {
313 pw = getpwnam(username);
319 pw->pw_gid = grp->gr_gid;
320 Debug(DPARS, ("load_entry()...uid %d, gid %d\n",pw->pw_uid,pw->pw_gid))
322 Debug(DPARS, ("load_entry()...class %s\n",e->class))
326 if (pw->pw_expire && time(NULL) >= pw->pw_expire) {
334 /* copy and fix up environment. some variables are just defaults and
335 * others are overrides.
337 e->envp = env_copy(envp);
338 if (e->envp == NULL) {
343 if (!env_get("SHELL", e->envp)) {
345 sprintf(envstr, "SHELL=%s", _PATH_BSHELL);
346 e->envp = env_set(e->envp, envstr);
347 if (e->envp == NULL) {
348 warn("env_set(%s)", envstr);
355 sprintf(envstr, "HOME=%s", pw->pw_dir);
356 e->envp = env_set(e->envp, envstr);
357 if (e->envp == NULL) {
358 warn("env_set(%s)", envstr);
363 if (!env_get("PATH", e->envp)) {
365 sprintf(envstr, "PATH=%s", _PATH_DEFPATH);
366 e->envp = env_set(e->envp, envstr);
367 if (e->envp == NULL) {
368 warn("env_set(%s)", envstr);
375 sprintf(envstr, "%s=%s", "LOGNAME", pw->pw_name);
376 e->envp = env_set(e->envp, envstr);
377 if (e->envp == NULL) {
378 warn("env_set(%s)", envstr);
385 sprintf(envstr, "%s=%s", "USER", pw->pw_name);
386 e->envp = env_set(e->envp, envstr);
387 if (e->envp == NULL) {
388 warn("env_set(%s)", envstr);
395 Debug(DPARS, ("load_entry()...about to parse command\n"))
397 /* Everything up to the next \n or EOF is part of the command...
398 * too bad we don't know in advance how long it will be, since we
399 * need to malloc a string for it... so, we limit it to MAX_COMMAND.
400 * XXX - should use realloc().
402 ch = get_string(cmd, MAX_COMMAND, file, "\n");
404 /* a file without a \n before the EOF is rude, so we'll complain...
411 /* got the command in the 'cmd' string; save it in *e.
413 e->cmd = strdup(cmd);
414 if (e->cmd == NULL) {
415 warn("strdup(\"%d\")", cmd);
419 Debug(DPARS, ("load_entry()...returning successfully\n"))
421 /* success, fini, return pointer to the entry we just created...
427 if (ecode != e_none && error_func)
428 (*error_func)(ecodes[(int)ecode]);
429 while (ch != EOF && ch != '\n')
436 get_list(bits, low, high, names, ch, file)
437 bitstr_t *bits; /* one bit per flag, default=FALSE */
438 int low, high; /* bounds, impl. offset for bitstr */
439 char *names[]; /* NULL or *[] of names for these elements */
440 int ch; /* current character being processed */
441 FILE *file; /* file being read */
445 /* we know that we point to a non-blank character here;
446 * must do a Skip_Blanks before we exit, so that the
447 * next call (or the code that picks up the cmd) can
448 * assume the same thing.
451 Debug(DPARS|DEXT, ("get_list()...entered\n"))
453 /* list = range {"," range}
456 /* clear the bit string, since the default is 'off'.
458 bit_nclear(bits, 0, (high-low+1));
460 /* process all ranges
464 ch = get_range(bits, low, high, names, ch, file);
471 /* exiting. skip to some blanks, then skip over the blanks.
473 Skip_Nonblanks(ch, file)
474 Skip_Blanks(ch, file)
476 Debug(DPARS|DEXT, ("get_list()...exiting w/ %02x\n", ch))
483 get_range(bits, low, high, names, ch, file)
484 bitstr_t *bits; /* one bit per flag, default=FALSE */
485 int low, high; /* bounds, impl. offset for bitstr */
486 char *names[]; /* NULL or names of elements */
487 int ch; /* current character being processed */
488 FILE *file; /* file being read */
490 /* range = number | number "-" number [ "/" number ]
494 auto int num1, num2, num3;
496 Debug(DPARS|DEXT, ("get_range()...entering, exit won't show\n"))
499 /* '*' means "first-last" but can still be modified by /step
507 if (EOF == (ch = get_number(&num1, low, names, ch, file)))
511 /* not a range, it's a single number.
513 if (EOF == set_element(bits, low, high, num1))
523 /* get the number following the dash
525 ch = get_number(&num2, low, names, ch, file);
531 /* check for step size
540 /* get the step size -- note: we don't pass the
541 * names here, because the number is not an
542 * element id, it's a step size. 'low' is
543 * sent as a 0 since there is no offset either.
545 ch = get_number(&num3, 0, PPC_NULL, ch, file);
549 /* no step. default==1.
554 /* range. set all elements from num1 to num2, stepping
555 * by num3. (the step is a downward-compatible extension
556 * proposed conceptually by bob@acornrc, syntactically
557 * designed then implmented by paul vixie).
559 for (i = num1; i <= num2; i += num3)
560 if (EOF == set_element(bits, low, high, i))
568 get_number(numptr, low, names, ch, file)
569 int *numptr; /* where does the result go? */
570 int low; /* offset applied to result if symbolic enum used */
571 char *names[]; /* symbolic names, if any, for enums */
572 int ch; /* current character */
573 FILE *file; /* source */
575 char temp[MAX_TEMPSTR], *pc;
576 int len, i, all_digits;
578 /* collect alphanumerics into our fixed-size temp array
583 while (isalnum(ch)) {
584 if (++len >= MAX_TEMPSTR)
596 /* try to find the name in the name list
599 for (i = 0; names[i] != NULL; i++) {
601 ("get_num, compare(%s,%s)\n", names[i], temp))
602 if (!strcasecmp(names[i], temp)) {
609 /* no name list specified, or there is one and our string isn't
610 * in it. either way: if it's all digits, use its magnitude.
611 * otherwise, it's an error.
614 *numptr = atoi(temp);
623 set_element(bits, low, high, number)
624 bitstr_t *bits; /* one bit per flag, default=FALSE */
629 Debug(DPARS|DEXT, ("set_element(?,%d,%d,%d)\n", low, high, number))
631 if (number < low || number > high)
634 bit_set(bits, (number-low));