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