1 /* Copyright 1988,1990,1993,1994 by Paul Vixie 2 * All rights reserved 3 * 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 11 * user. 12 * 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 16 */ 17 18 /* cron.h - header for vixie's cron 19 * 20 * $FreeBSD$ 21 * 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] 25 */ 26 27 /* reorder these #include's at your peril */ 28 29 #include <sys/types.h> 30 #include <sys/param.h> 31 #include "compat.h" 32 33 #include <bitstring.h> 34 #include <ctype.h> 35 #include <err.h> 36 #include <errno.h> 37 #include <libutil.h> 38 #include <pwd.h> 39 #include <signal.h> 40 #include <stdio.h> 41 #include <time.h> 42 #include <sys/wait.h> 43 44 #include "pathnames.h" 45 #include "config.h" 46 #include "externs.h" 47 48 /* these are really immutable, and are 49 * defined for symbolic convenience only 50 * TRUE, FALSE, and ERR must be distinct 51 * ERR must be < OK. 52 */ 53 #define TRUE 1 54 #define FALSE 0 55 /* system calls return this on success */ 56 #define OK 0 57 /* or this on error */ 58 #define ERR (-1) 59 60 /* turn this on to get '-x' code */ 61 #ifndef DEBUGGING 62 #define DEBUGGING FALSE 63 #endif 64 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 80 /* NOTE: these correspond to DebugFlagNames, 81 * defined below. 82 */ 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) */ 91 92 #define CRON_TAB(u) "%s/%s", SPOOL_DIR, u 93 #define REG register 94 #define PPC_NULL ((char **)NULL) 95 96 #ifndef MAXHOSTNAMELEN 97 #define MAXHOSTNAMELEN 256 98 #endif 99 100 #define Skip_Blanks(c, f) \ 101 while (c == '\t' || c == ' ') \ 102 c = get_char(f); 103 104 #define Skip_Nonblanks(c, f) \ 105 while (c!='\t' && c!=' ' && c!='\n' && c != EOF) \ 106 c = get_char(f); 107 108 #define Skip_Line(c, f) \ 109 do {c = get_char(f);} while (c != '\n' && c != EOF); 110 111 #if DEBUGGING 112 # define Debug(mask, message) \ 113 if ( (DebugFlags & (mask) ) == (mask) ) \ 114 printf message; 115 #else /* !DEBUGGING */ 116 # define Debug(mask, message) \ 117 ; 118 #endif /* DEBUGGING */ 119 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)); \ 123 LineNumber = ln; \ 124 } 125 126 #define FIRST_MINUTE 0 127 #define LAST_MINUTE 59 128 #define MINUTE_COUNT (LAST_MINUTE - FIRST_MINUTE + 1) 129 130 #define FIRST_HOUR 0 131 #define LAST_HOUR 23 132 #define HOUR_COUNT (LAST_HOUR - FIRST_HOUR + 1) 133 134 #define FIRST_DOM 1 135 #define LAST_DOM 31 136 #define DOM_COUNT (LAST_DOM - FIRST_DOM + 1) 137 138 #define FIRST_MONTH 1 139 #define LAST_MONTH 12 140 #define MONTH_COUNT (LAST_MONTH - FIRST_MONTH + 1) 141 142 /* note on DOW: 0 and 7 are both Sunday, for compatibility reasons. */ 143 #define FIRST_DOW 0 144 #define LAST_DOW 7 145 #define DOW_COUNT (LAST_DOW - FIRST_DOW + 1) 146 147 #ifdef LOGIN_CAP 148 /* see init.c */ 149 #define RESOURCE_RC "daemon" 150 #endif 151 152 /* each user's crontab will be held as a list of 153 * the following structure. 154 * 155 * These are the cron commands. 156 */ 157 158 typedef struct _entry { 159 struct _entry *next; 160 uid_t uid; 161 gid_t gid; 162 #ifdef LOGIN_CAP 163 char *class; 164 #endif 165 char **envp; 166 char *cmd; 167 bitstr_t bit_decl(minute, MINUTE_COUNT); 168 bitstr_t bit_decl(hour, HOUR_COUNT); 169 bitstr_t bit_decl(dom, DOM_COUNT); 170 bitstr_t bit_decl(month, MONTH_COUNT); 171 bitstr_t bit_decl(dow, DOW_COUNT); 172 int flags; 173 #define DOM_STAR 0x01 174 #define DOW_STAR 0x02 175 #define WHEN_REBOOT 0x04 176 #define RUN_AT 0x08 177 #define NOT_UNTIL 0x10 178 time_t lastrun; 179 } entry; 180 181 /* the crontab database will be a list of the 182 * following structure, one element per user 183 * plus one for the system. 184 * 185 * These are the crontabs. 186 */ 187 188 typedef struct _user { 189 struct _user *next, *prev; /* links */ 190 char *name; 191 time_t mtime; /* last modtime of crontab */ 192 entry *crontab; /* this person's crontab */ 193 } user; 194 195 typedef struct _cron_db { 196 user *head, *tail; /* links */ 197 time_t mtime; /* last modtime on spooldir */ 198 } cron_db; 199 200 201 void set_cron_uid __P((void)), 202 set_cron_cwd __P((void)), 203 load_database __P((cron_db *)), 204 open_logfile __P((void)), 205 sigpipe_func __P((void)), 206 job_add __P((entry *, user *)), 207 do_command __P((entry *, user *)), 208 link_user __P((cron_db *, user *)), 209 unlink_user __P((cron_db *, user *)), 210 free_user __P((user *)), 211 env_free __P((char **)), 212 unget_char __P((int, FILE *)), 213 free_entry __P((entry *)), 214 skip_comments __P((FILE *)), 215 log_it __P((char *, int, char *, char *)), 216 log_close __P((void)); 217 218 int job_runqueue __P((void)), 219 set_debug_flags __P((char *)), 220 get_char __P((FILE *)), 221 get_string __P((char *, int, FILE *, char *)), 222 swap_uids __P((void)), 223 load_env __P((char *, FILE *)), 224 cron_pclose __P((FILE *)), 225 strcmp_until __P((char *, char *, int)), 226 allowed __P((char *)), 227 strdtb __P((char *)); 228 229 char *env_get __P((char *, char **)), 230 *arpadate __P((time_t *)), 231 *mkprints __P((unsigned char *, unsigned int)), 232 *first_word __P((char *, char *)), 233 **env_init __P((void)), 234 **env_copy __P((char **)), 235 **env_set __P((char **, char *)); 236 237 user *load_user __P((int, struct passwd *, char *)), 238 *find_user __P((cron_db *, char *)); 239 240 entry *load_entry __P((FILE *, void (*)(), 241 struct passwd *, char **)); 242 243 FILE *cron_popen __P((char *, char *, entry *)); 244 245 246 /* in the C tradition, we only create 247 * variables for the main program, just 248 * extern them elsewhere. 249 */ 250 251 #ifdef MAIN_PROGRAM 252 # if !defined(LINT) && !defined(lint) 253 char *copyright[] = { 254 "@(#) Copyright 1988,1989,1990,1993,1994 by Paul Vixie", 255 "@(#) All rights reserved" 256 }; 257 # endif 258 259 char *MonthNames[] = { 260 "Jan", "Feb", "Mar", "Apr", "May", "Jun", 261 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec", 262 NULL 263 }; 264 265 char *DowNames[] = { 266 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun", 267 NULL 268 }; 269 270 char *ProgramName; 271 int LineNumber; 272 unsigned Jitter, 273 RootJitter; 274 time_t TargetTime; 275 276 # if DEBUGGING 277 int DebugFlags; 278 char *DebugFlagNames[] = { /* sync with #defines */ 279 "ext", "sch", "proc", "pars", "load", "misc", "test", "bit", 280 NULL /* NULL must be last element */ 281 }; 282 # endif /* DEBUGGING */ 283 #else /*MAIN_PROGRAM*/ 284 extern char *copyright[], 285 *MonthNames[], 286 *DowNames[], 287 *ProgramName; 288 extern int LineNumber; 289 extern unsigned Jitter, 290 RootJitter; 291 extern time_t TargetTime; 292 extern struct pidfh *pfh; 293 # if DEBUGGING 294 extern int DebugFlags; 295 extern char *DebugFlagNames[]; 296 # endif /* DEBUGGING */ 297 #endif /*MAIN_PROGRAM*/ 298