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_MINUTE 0
128 #define LAST_MINUTE 59
129 #define MINUTE_COUNT (LAST_MINUTE - FIRST_MINUTE + 1)
133 #define HOUR_COUNT (LAST_HOUR - FIRST_HOUR + 1)
137 #define DOM_COUNT (LAST_DOM - FIRST_DOM + 1)
139 #define FIRST_MONTH 1
140 #define LAST_MONTH 12
141 #define MONTH_COUNT (LAST_MONTH - FIRST_MONTH + 1)
143 /* note on DOW: 0 and 7 are both Sunday, for compatibility reasons. */
146 #define DOW_COUNT (LAST_DOW - FIRST_DOW + 1)
150 #define RESOURCE_RC "daemon"
153 /* each user's crontab will be held as a list of
154 * the following structure.
156 * These are the cron commands.
159 typedef struct _entry {
168 bitstr_t bit_decl(minute, MINUTE_COUNT);
169 bitstr_t bit_decl(hour, HOUR_COUNT);
170 bitstr_t bit_decl(dom, DOM_COUNT);
171 bitstr_t bit_decl(month, MONTH_COUNT);
172 bitstr_t bit_decl(dow, DOW_COUNT);
174 #define DOM_STAR 0x01
175 #define DOW_STAR 0x02
176 #define WHEN_REBOOT 0x04
178 #define NOT_UNTIL 0x10
182 /* the crontab database will be a list of the
183 * following structure, one element per user
184 * plus one for the system.
186 * These are the crontabs.
189 typedef struct _user {
190 struct _user *next, *prev; /* links */
192 time_t mtime; /* last modtime of crontab */
193 entry *crontab; /* this person's crontab */
196 typedef struct _cron_db {
197 user *head, *tail; /* links */
198 time_t mtime; /* last modtime on spooldir */
202 void set_cron_uid __P((void)),
203 set_cron_cwd __P((void)),
204 load_database __P((cron_db *)),
205 open_logfile __P((void)),
206 sigpipe_func __P((void)),
207 job_add __P((entry *, user *)),
208 do_command __P((entry *, user *)),
209 link_user __P((cron_db *, user *)),
210 unlink_user __P((cron_db *, user *)),
211 free_user __P((user *)),
212 env_free __P((char **)),
213 unget_char __P((int, FILE *)),
214 free_entry __P((entry *)),
215 skip_comments __P((FILE *)),
216 log_it __P((char *, int, char *, char *)),
217 log_close __P((void));
219 int job_runqueue __P((void)),
220 set_debug_flags __P((char *)),
221 get_char __P((FILE *)),
222 get_string __P((char *, int, FILE *, char *)),
223 swap_uids __P((void)),
224 load_env __P((char *, FILE *)),
225 cron_pclose __P((FILE *)),
226 strcmp_until __P((char *, char *, int)),
227 allowed __P((char *)),
228 strdtb __P((char *));
230 char *env_get __P((char *, char **)),
231 *arpadate __P((time_t *)),
232 *mkprints __P((unsigned char *, unsigned int)),
233 *first_word __P((char *, char *)),
234 **env_init __P((void)),
235 **env_copy __P((char **)),
236 **env_set __P((char **, char *));
238 user *load_user __P((int, struct passwd *, char *)),
239 *find_user __P((cron_db *, char *));
241 entry *load_entry __P((FILE *, void (*)(),
242 struct passwd *, char **));
244 FILE *cron_popen __P((char *, char *, entry *));
247 /* in the C tradition, we only create
248 * variables for the main program, just
249 * extern them elsewhere.
253 # if !defined(LINT) && !defined(lint)
254 char *copyright[] = {
255 "@(#) Copyright 1988,1989,1990,1993,1994 by Paul Vixie",
256 "@(#) All rights reserved"
260 char *MonthNames[] = {
261 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
262 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
267 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun",
280 char *DebugFlagNames[] = { /* sync with #defines */
281 "ext", "sch", "proc", "pars", "load", "misc", "test", "bit",
282 NULL /* NULL must be last element */
284 # endif /* DEBUGGING */
285 #else /*MAIN_PROGRAM*/
286 extern char *copyright[],
291 extern int LineNumber;
292 extern unsigned Jitter,
294 extern time_t TargetTime;
295 extern struct pidfh *pfh;
297 extern int DebugFlags;
298 extern char *DebugFlagNames[];
299 # endif /* DEBUGGING */
300 #endif /*MAIN_PROGRAM*/