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 ROOT_UID 0 /* don't change this, it really must be root */
77 #define ROOT_USER "root" /* ditto */
78 #define SYS_NAME "*system*" /* magic owner name for system crontab */
80 /* NOTE: these correspond to DebugFlagNames,
83 #define DEXT 0x0001 /* extend flag for other debug masks */
84 #define DSCH 0x0002 /* scheduling debug mask */
85 #define DPROC 0x0004 /* process control debug mask */
86 #define DPARS 0x0008 /* parsing debug mask */
87 #define DLOAD 0x0010 /* database loading debug mask */
88 #define DMISC 0x0020 /* misc debug mask */
89 #define DTEST 0x0040 /* test mode: don't execute any commands */
90 #define DBIT 0x0080 /* bit twiddling shown (long) */
92 #define CRON_TAB(u) "%s/%s", SPOOL_DIR, u
94 #define PPC_NULL ((char **)NULL)
96 #ifndef MAXHOSTNAMELEN
97 #define MAXHOSTNAMELEN 256
100 #define Skip_Blanks(c, f) \
101 while (c == '\t' || c == ' ') \
104 #define Skip_Nonblanks(c, f) \
105 while (c!='\t' && c!=' ' && c!='\n' && c != EOF) \
108 #define Skip_Line(c, f) \
109 do {c = get_char(f);} while (c != '\n' && c != EOF);
112 # define Debug(mask, message) \
113 if ( (DebugFlags & (mask) ) == (mask) ) \
115 #else /* !DEBUGGING */
116 # define Debug(mask, message) \
118 #endif /* DEBUGGING */
120 #define MkLower(ch) (isupper(ch) ? tolower(ch) : ch)
121 #define MkUpper(ch) (islower(ch) ? toupper(ch) : ch)
122 #define Set_LineNum(ln) {Debug(DPARS|DEXT,("linenum=%d\n",ln)); \
126 #define FIRST_SECOND 0
127 #define LAST_SECOND 59
128 #define SECOND_COUNT (LAST_SECOND - FIRST_SECOND + 1)
130 #define FIRST_MINUTE 0
131 #define LAST_MINUTE 59
132 #define MINUTE_COUNT (LAST_MINUTE - FIRST_MINUTE + 1)
136 #define HOUR_COUNT (LAST_HOUR - FIRST_HOUR + 1)
140 #define DOM_COUNT (LAST_DOM - FIRST_DOM + 1)
142 #define FIRST_MONTH 1
143 #define LAST_MONTH 12
144 #define MONTH_COUNT (LAST_MONTH - FIRST_MONTH + 1)
146 /* note on DOW: 0 and 7 are both Sunday, for compatibility reasons. */
149 #define DOW_COUNT (LAST_DOW - FIRST_DOW + 1)
153 #define RESOURCE_RC "daemon"
156 /* each user's crontab will be held as a list of
157 * the following structure.
159 * These are the cron commands.
162 typedef struct _entry {
171 bitstr_t bit_decl(second, SECOND_COUNT);
172 bitstr_t bit_decl(minute, MINUTE_COUNT);
173 bitstr_t bit_decl(hour, HOUR_COUNT);
174 bitstr_t bit_decl(dom, DOM_COUNT);
175 bitstr_t bit_decl(month, MONTH_COUNT);
176 bitstr_t bit_decl(dow, DOW_COUNT);
178 #define DOM_STAR 0x01
179 #define DOW_STAR 0x02
180 #define WHEN_REBOOT 0x04
182 #define NOT_UNTIL 0x10
187 /* the crontab database will be a list of the
188 * following structure, one element per user
189 * plus one for the system.
191 * These are the crontabs.
194 typedef struct _user {
195 struct _user *next, *prev; /* links */
197 time_t mtime; /* last modtime of crontab */
198 entry *crontab; /* this person's crontab */
201 typedef struct _cron_db {
202 user *head, *tail; /* links */
203 time_t mtime; /* last modtime on spooldir */
207 void set_cron_uid(void),
209 load_database(cron_db *),
212 job_add(entry *, user *),
213 do_command(entry *, user *),
214 link_user(cron_db *, user *),
215 unlink_user(cron_db *, user *),
218 unget_char(int, FILE *),
220 skip_comments(FILE *),
221 log_it(char *, int, char *, const char *),
224 int job_runqueue(void),
225 set_debug_flags(char *),
227 get_string(char *, int, FILE *, char *),
229 swap_uids_back(void),
230 load_env(char *, FILE *),
232 strcmp_until(char *, char *, int),
236 char *env_get(char *, char **),
238 *mkprints(unsigned char *, unsigned int),
239 *first_word(char *, char *),
242 **env_set(char **, char *);
244 user *load_user(int, struct passwd *, char *),
245 *find_user(cron_db *, char *);
247 entry *load_entry(FILE *, void (*)(char *),
248 struct passwd *, char **);
250 FILE *cron_popen(char *, char *, entry *);
253 /* in the C tradition, we only create
254 * variables for the main program, just
255 * extern them elsewhere.
259 # if !defined(LINT) && !defined(lint)
260 char *copyright[] = {
261 "@(#) Copyright 1988,1989,1990,1993,1994 by Paul Vixie",
262 "@(#) All rights reserved"
266 char *MonthNames[] = {
267 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
268 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
273 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun",
286 char *DebugFlagNames[] = { /* sync with #defines */
287 "ext", "sch", "proc", "pars", "load", "misc", "test", "bit",
288 NULL /* NULL must be last element */
290 # endif /* DEBUGGING */
291 #else /*MAIN_PROGRAM*/
292 extern char *copyright[],
297 extern int LineNumber;
298 extern unsigned Jitter,
300 extern time_t TargetTime;
301 extern struct pidfh *pfh;
303 extern int DebugFlags;
304 extern char *DebugFlagNames[];
305 # endif /* DEBUGGING */
306 #endif /*MAIN_PROGRAM*/