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 /* cron.h - header for vixie's cron
22 * vix 14nov88 [rest of log is in RCS]
23 * vix 14jan87 [0 or 7 can be sunday; thanks, mwm@berkeley]
24 * vix 30dec86 [written]
27 /* reorder these #include's at your peril */
29 #include <sys/types.h>
30 #include <sys/param.h>
33 #include <bitstring.h>
44 #include "pathnames.h"
48 /* these are really immutable, and are
49 * defined for symbolic convenience only
50 * TRUE, FALSE, and ERR must be distinct
55 /* system calls return this on success */
57 /* or this on error */
60 /* turn this on to get '-x' code */
62 #define DEBUGGING FALSE
65 #define READ_PIPE 0 /* which end of a pipe pair do you read? */
66 #define WRITE_PIPE 1 /* or write to? */
67 #define STDIN 0 /* what is stdin's file descriptor? */
68 #define STDOUT 1 /* stdout's? */
69 #define STDERR 2 /* stderr's? */
70 #define ERROR_EXIT 1 /* exit() with this will scare the shell */
71 #define OK_EXIT 0 /* exit() with this is considered 'normal' */
72 #define MAX_FNAME 100 /* max length of internally generated fn */
73 #define MAX_COMMAND 1000 /* max length of internally generated cmd */
74 #define MAX_ENVSTR 1000 /* max length of envvar=value\0 strings */
75 #define MAX_TEMPSTR 100 /* obvious */
76 #define MAX_UNAME 20 /* max length of username, should be overkill */
77 #define ROOT_UID 0 /* don't change this, it really must be root */
78 #define ROOT_USER "root" /* ditto */
79 #define SYS_NAME "*system*" /* magic owner name for system crontab */
81 /* NOTE: these correspond to DebugFlagNames,
84 #define DEXT 0x0001 /* extend flag for other debug masks */
85 #define DSCH 0x0002 /* scheduling debug mask */
86 #define DPROC 0x0004 /* process control debug mask */
87 #define DPARS 0x0008 /* parsing debug mask */
88 #define DLOAD 0x0010 /* database loading debug mask */
89 #define DMISC 0x0020 /* misc debug mask */
90 #define DTEST 0x0040 /* test mode: don't execute any commands */
91 #define DBIT 0x0080 /* bit twiddling shown (long) */
93 #define CRON_TAB(u) "%s/%s", SPOOL_DIR, u
95 #define PPC_NULL ((char **)NULL)
97 #ifndef MAXHOSTNAMELEN
98 #define MAXHOSTNAMELEN 256
101 #define Skip_Blanks(c, f) \
102 while (c == '\t' || c == ' ') \
105 #define Skip_Nonblanks(c, f) \
106 while (c!='\t' && c!=' ' && c!='\n' && c != EOF) \
109 #define Skip_Line(c, f) \
110 do {c = get_char(f);} while (c != '\n' && c != EOF);
113 # define Debug(mask, message) \
114 if ( (DebugFlags & (mask) ) == (mask) ) \
116 #else /* !DEBUGGING */
117 # define Debug(mask, message) \
119 #endif /* DEBUGGING */
121 #define MkLower(ch) (isupper(ch) ? tolower(ch) : ch)
122 #define MkUpper(ch) (islower(ch) ? toupper(ch) : ch)
123 #define Set_LineNum(ln) {Debug(DPARS|DEXT,("linenum=%d\n",ln)); \
127 #define FIRST_SECOND 0
128 #define LAST_SECOND 59
129 #define SECOND_COUNT (LAST_SECOND - FIRST_SECOND + 1)
131 #define FIRST_MINUTE 0
132 #define LAST_MINUTE 59
133 #define MINUTE_COUNT (LAST_MINUTE - FIRST_MINUTE + 1)
137 #define HOUR_COUNT (LAST_HOUR - FIRST_HOUR + 1)
141 #define DOM_COUNT (LAST_DOM - FIRST_DOM + 1)
143 #define FIRST_MONTH 1
144 #define LAST_MONTH 12
145 #define MONTH_COUNT (LAST_MONTH - FIRST_MONTH + 1)
147 /* note on DOW: 0 and 7 are both Sunday, for compatibility reasons. */
150 #define DOW_COUNT (LAST_DOW - FIRST_DOW + 1)
154 #define RESOURCE_RC "daemon"
157 /* each user's crontab will be held as a list of
158 * the following structure.
160 * These are the cron commands.
163 typedef struct _entry {
172 bitstr_t bit_decl(second, SECOND_COUNT);
173 bitstr_t bit_decl(minute, MINUTE_COUNT);
174 bitstr_t bit_decl(hour, HOUR_COUNT);
175 bitstr_t bit_decl(dom, DOM_COUNT);
176 bitstr_t bit_decl(month, MONTH_COUNT);
177 bitstr_t bit_decl(dow, DOW_COUNT);
179 #define DOM_STAR 0x01
180 #define DOW_STAR 0x02
181 #define WHEN_REBOOT 0x04
183 #define NOT_UNTIL 0x10
188 /* the crontab database will be a list of the
189 * following structure, one element per user
190 * plus one for the system.
192 * These are the crontabs.
195 typedef struct _user {
196 struct _user *next, *prev; /* links */
198 time_t mtime; /* last modtime of crontab */
199 entry *crontab; /* this person's crontab */
202 typedef struct _cron_db {
203 user *head, *tail; /* links */
204 time_t mtime; /* last modtime on spooldir */
208 void set_cron_uid(void),
210 load_database(cron_db *),
213 job_add(entry *, user *),
214 do_command(entry *, user *),
215 link_user(cron_db *, user *),
216 unlink_user(cron_db *, user *),
219 unget_char(int, FILE *),
221 skip_comments(FILE *),
222 log_it(char *, int, char *, char *),
225 int job_runqueue(void),
226 set_debug_flags(char *),
228 get_string(char *, int, FILE *, char *),
230 swap_uids_back(void),
231 load_env(char *, FILE *),
233 strcmp_until(char *, char *, int),
237 char *env_get(char *, char **),
239 *mkprints(unsigned char *, unsigned int),
240 *first_word(char *, char *),
243 **env_set(char **, char *);
245 user *load_user(int, struct passwd *, char *),
246 *find_user(cron_db *, char *);
248 entry *load_entry(FILE *, void (*)(char *),
249 struct passwd *, char **);
251 FILE *cron_popen(char *, char *, entry *);
254 /* in the C tradition, we only create
255 * variables for the main program, just
256 * extern them elsewhere.
260 # if !defined(LINT) && !defined(lint)
261 char *copyright[] = {
262 "@(#) Copyright 1988,1989,1990,1993,1994 by Paul Vixie",
263 "@(#) All rights reserved"
267 char *MonthNames[] = {
268 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
269 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
274 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun",
287 char *DebugFlagNames[] = { /* sync with #defines */
288 "ext", "sch", "proc", "pars", "load", "misc", "test", "bit",
289 NULL /* NULL must be last element */
291 # endif /* DEBUGGING */
292 #else /*MAIN_PROGRAM*/
293 extern char *copyright[],
298 extern int LineNumber;
299 extern unsigned Jitter,
301 extern time_t TargetTime;
302 extern struct pidfh *pfh;
304 extern int DebugFlags;
305 extern char *DebugFlagNames[];
306 # endif /* DEBUGGING */
307 #endif /*MAIN_PROGRAM*/