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 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 */ 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_SECOND 0 127 #define LAST_SECOND 59 128 #define SECOND_COUNT (LAST_SECOND - FIRST_SECOND + 1) 129 130 #define FIRST_MINUTE 0 131 #define LAST_MINUTE 59 132 #define MINUTE_COUNT (LAST_MINUTE - FIRST_MINUTE + 1) 133 134 #define FIRST_HOUR 0 135 #define LAST_HOUR 23 136 #define HOUR_COUNT (LAST_HOUR - FIRST_HOUR + 1) 137 138 #define FIRST_DOM 1 139 #define LAST_DOM 31 140 #define DOM_COUNT (LAST_DOM - FIRST_DOM + 1) 141 142 #define FIRST_MONTH 1 143 #define LAST_MONTH 12 144 #define MONTH_COUNT (LAST_MONTH - FIRST_MONTH + 1) 145 146 /* note on DOW: 0 and 7 are both Sunday, for compatibility reasons. */ 147 #define FIRST_DOW 0 148 #define LAST_DOW 7 149 #define DOW_COUNT (LAST_DOW - FIRST_DOW + 1) 150 151 #ifdef LOGIN_CAP 152 /* see init.c */ 153 #define RESOURCE_RC "daemon" 154 #endif 155 156 /* each user's crontab will be held as a list of 157 * the following structure. 158 * 159 * These are the cron commands. 160 */ 161 162 typedef struct _entry { 163 struct _entry *next; 164 uid_t uid; 165 gid_t gid; 166 #ifdef LOGIN_CAP 167 char *class; 168 #endif 169 char **envp; 170 char *cmd; 171 union { 172 struct { 173 bitstr_t bit_decl(second, SECOND_COUNT); 174 bitstr_t bit_decl(minute, MINUTE_COUNT); 175 bitstr_t bit_decl(hour, HOUR_COUNT); 176 bitstr_t bit_decl(dom, DOM_COUNT); 177 bitstr_t bit_decl(month, MONTH_COUNT); 178 bitstr_t bit_decl(dow, DOW_COUNT); 179 }; 180 struct { 181 time_t lastexit; 182 time_t interval; 183 pid_t child; 184 }; 185 }; 186 int flags; 187 #define DOM_STAR 0x01 188 #define DOW_STAR 0x02 189 #define WHEN_REBOOT 0x04 190 #define RUN_AT 0x08 191 #define NOT_UNTIL 0x10 192 #define SEC_RES 0x20 193 #define INTERVAL 0x40 194 #define DONT_LOG 0x80 195 #define MAIL_WHEN_ERR 0x100 196 time_t lastrun; 197 } entry; 198 199 /* the crontab database will be a list of the 200 * following structure, one element per user 201 * plus one for the system. 202 * 203 * These are the crontabs. 204 */ 205 206 typedef struct _user { 207 struct _user *next, *prev; /* links */ 208 char *name; 209 time_t mtime; /* last modtime of crontab */ 210 entry *crontab; /* this person's crontab */ 211 } user; 212 213 typedef struct _cron_db { 214 user *head, *tail; /* links */ 215 time_t mtime; /* last modtime on spooldir */ 216 } cron_db; 217 218 219 void set_cron_uid(void), 220 set_cron_cwd(void), 221 load_database(cron_db *), 222 open_logfile(void), 223 sigpipe_func(void), 224 job_add(entry *, user *), 225 do_command(entry *, user *), 226 link_user(cron_db *, user *), 227 unlink_user(cron_db *, user *), 228 free_user(user *), 229 env_free(char **), 230 unget_char(int, FILE *), 231 free_entry(entry *), 232 skip_comments(FILE *), 233 log_it(char *, int, char *, const char *), 234 log_close(void); 235 236 int job_runqueue(void), 237 set_debug_flags(char *), 238 get_char(FILE *), 239 get_string(char *, int, FILE *, char *), 240 swap_uids(void), 241 swap_uids_back(void), 242 load_env(char *, FILE *), 243 cron_pclose(FILE *), 244 strcmp_until(char *, char *, int), 245 allowed(char *), 246 strdtb(char *); 247 248 char *env_get(char *, char **), 249 *arpadate(time_t *), 250 *mkprints(unsigned char *, unsigned int), 251 *first_word(char *, char *), 252 **env_init(void), 253 **env_copy(char **), 254 **env_set(char **, char *); 255 256 user *load_user(int, struct passwd *, char *), 257 *find_user(cron_db *, char *); 258 259 entry *load_entry(FILE *, void (*)(char *), 260 struct passwd *, char **); 261 262 FILE *cron_popen(char *, char *, entry *, PID_T *); 263 264 265 /* in the C tradition, we only create 266 * variables for the main program, just 267 * extern them elsewhere. 268 */ 269 270 #ifdef MAIN_PROGRAM 271 # if !defined(LINT) && !defined(lint) 272 char *copyright[] = { 273 "@(#) Copyright 1988,1989,1990,1993,1994 by Paul Vixie", 274 "@(#) All rights reserved" 275 }; 276 # endif 277 278 char *MonthNames[] = { 279 "Jan", "Feb", "Mar", "Apr", "May", "Jun", 280 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec", 281 NULL 282 }; 283 284 char *DowNames[] = { 285 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun", 286 NULL 287 }; 288 289 char *ProgramName, 290 *defmailto; 291 int LineNumber; 292 unsigned Jitter, 293 RootJitter; 294 time_t TargetTime; 295 296 # if DEBUGGING 297 int DebugFlags; 298 char *DebugFlagNames[] = { /* sync with #defines */ 299 "ext", "sch", "proc", "pars", "load", "misc", "test", "bit", 300 NULL /* NULL must be last element */ 301 }; 302 # endif /* DEBUGGING */ 303 #else /*MAIN_PROGRAM*/ 304 extern char *copyright[], 305 *MonthNames[], 306 *DowNames[], 307 *ProgramName, 308 *defmailto; 309 extern int LineNumber; 310 extern unsigned Jitter, 311 RootJitter; 312 extern time_t TargetTime; 313 extern struct pidfh *pfh; 314 # if DEBUGGING 315 extern int DebugFlags; 316 extern char *DebugFlagNames[]; 317 # endif /* DEBUGGING */ 318 #endif /*MAIN_PROGRAM*/ 319