1 /*
2 **  SENDMAIL.H -- Global definitions for sendmail.
3 */
4 
5 
6 
7 # ifdef _DEFINE
8 # define EXTERN
9 # ifndef lint
10 static char SmailSccsId[] =	"@(#)sendmail.h	3.57		01/23/82";
11 # endif lint
12 # else  _DEFINE
13 # define EXTERN extern
14 # endif _DEFINE
15 
16 # include <stdio.h>
17 # include <ctype.h>
18 # include "useful.h"
19 
20 /*
21 **  Configuration constants.
22 **	There shouldn't be much need to change these....
23 */
24 
25 # define MAXLINE	256		/* max line length */
26 # define MAXNAME	128		/* max length of a name */
27 # define MAXFIELD	2500		/* max total length of a hdr field */
28 # define MAXPV		40		/* max # of parms to mailers */
29 # define MAXHOP		30		/* max value of HopCount */
30 # define MAXATOM	30		/* max atoms per address */
31 # define MAXMAILERS	10		/* maximum mailers known to system */
32 # define SPACESUB	('.'|0200)	/* substitution for <lwsp> */
33 
34 extern char	Arpa_Info[];	/* the message number for Arpanet info */
35 
36 
37 
38 
39 
40 
41 /*
42 **  Address structure.
43 **	Addresses are stored internally in this structure.
44 */
45 
46 struct address
47 {
48 	char		*q_paddr;	/* the printname for the address */
49 	char		*q_user;	/* user name */
50 	char		*q_host;	/* host name */
51 	struct mailer	*q_mailer;	/* mailer to use */
52 	short		q_rmailer;	/* real mailer (before mapping) */
53 	u_short		q_flags;	/* status flags, see below */
54 	short		q_uid;		/* user-id of receiver (if known) */
55 	short		q_gid;		/* group-id of receiver (if known) */
56 	char		*q_home;	/* home dir (local mailer only) */
57 	char		*q_fullname;	/* full name if known */
58 	struct address	*q_next;	/* chain */
59 	struct address	*q_alias;	/* address this results from */
60 	struct address	*q_tchain;	/* temporary use chain */
61 	time_t		q_timeout;	/* timeout for this address */
62 };
63 
64 typedef struct address ADDRESS;
65 
66 # define QDONTSEND	000001	/* don't send to this address */
67 # define QBADADDR	000002	/* this address is verified bad */
68 # define QGOODUID	000004	/* the q_uid q_gid fields are good */
69 # define QPRIMARY	000010	/* set from argv */
70 # define QQUEUEUP	000020	/* queue for later transmission */
71 
72 
73 
74 
75 
76 /*
77 **  Mailer definition structure.
78 **	Every mailer known to the system is declared in this
79 **	structure.  It defines the pathname of the mailer, some
80 **	flags associated with it, and the argument vector to
81 **	pass to it.  The flags are defined in conf.c
82 **
83 **	The argument vector is expanded before actual use.  All
84 **	words except the first are passed through the macro
85 **	processor.
86 */
87 
88 struct mailer
89 {
90 	char	*m_name;	/* symbolic name of this mailer */
91 	char	*m_mailer;	/* pathname of the mailer to use */
92 	u_long	m_flags;	/* status flags, see below */
93 	short	m_badstat;	/* the status code to use on unknown error */
94 	short	m_mno;		/* mailer number internally */
95 	char	*m_from;	/* pattern for From: header */
96 	char	**m_argv;	/* template argument vector */
97 };
98 
99 typedef struct mailer	MAILER;
100 
101 /* bits for m_flags */
102 # define M_FOPT		000000001	/* mailer takes picky -f flag */
103 # define M_ROPT		000000002	/* mailer takes picky -r flag */
104 # define M_QUIET	000000004	/* don't print error on bad status */
105 # define M_RESTR	000000010	/* must be daemon to execute */
106 # define M_NHDR		000000020	/* don't insert From line */
107 # define M_LOCAL	000000040	/* delivery is to this host */
108 # define M_STRIPQ	000000100	/* strip quote chars from user/host */
109 # define M_MUSER	000000200	/* can handle multiple users at once */
110 # define M_NEEDFROM	000000400	/* need arpa-style From: line */
111 # define M_NEEDDATE	000001000	/* need arpa-style Date: line */
112 # define M_MSGID	000002000	/* need Message-Id: field */
113 # define M_USR_UPPER	000010000	/* preserve user case distinction */
114 # define M_HST_UPPER	000020000	/* preserve host case distinction */
115 # define M_FULLNAME	000040000	/* want Full-Name field */
116 # define M_UGLYUUCP	000100000	/* this wants an ugly UUCP from line */
117 
118 # define M_ARPAFMT	(M_NEEDDATE|M_NEEDFROM|M_MSGID)
119 
120 EXTERN MAILER	*Mailer[MAXMAILERS+1];
121 
122 EXTERN MAILER	*LocalMailer;		/* ptr to local mailer */
123 EXTERN MAILER	*ProgMailer;		/* ptr to program mailer */
124 
125 
126 /*
127 **  Header structure.
128 **	This structure is used internally to store header items.
129 */
130 
131 struct header
132 {
133 	char		*h_field;	/* the name of the field */
134 	char		*h_value;	/* the value of that field */
135 	struct header	*h_link;	/* the next header */
136 	u_short		h_flags;	/* status bits, see below */
137 	u_long		h_mflags;	/* m_flags bits needed */
138 };
139 
140 typedef struct header	HDR;
141 
142 EXTERN HDR	*Header;	/* head of header list */
143 
144 /*
145 **  Header information structure.
146 **	Defined in conf.c, this struct declares the header fields
147 **	that have some magic meaning.
148 */
149 
150 struct hdrinfo
151 {
152 	char	*hi_field;	/* the name of the field */
153 	u_short	hi_flags;	/* status bits, see below */
154 	u_short	hi_mflags;	/* m_flags needed for this field */
155 };
156 
157 extern struct hdrinfo	HdrInfo[];
158 
159 /* bits for h_flags and hi_flags */
160 # define H_EOH		00001	/* this field terminates header */
161 # define H_DEFAULT	00004	/* if another value is found, drop this */
162 # define H_USED		00010	/* indicates that this has been output */
163 # define H_CHECK	00020	/* check h_mflags against m_flags */
164 # define H_ACHECK	00040	/* ditto, but always (not just default) */
165 # define H_FORCE	00100	/* force this field, even if default */
166 # define H_ADDR		00200	/* this field contains addresses */
167 
168 
169 
170 /*
171 **  Work queue.
172 */
173 
174 struct work
175 {
176 	char		*w_name;	/* name of control file */
177 	long		w_pri;		/* priority of message, see below */
178 	struct work	*w_next;	/* next in queue */
179 };
180 
181 typedef struct work	WORK;
182 
183 EXTERN WORK	*WorkQ;			/* queue of things to be done */
184 
185 
186 /*
187 **  Message priorities.
188 **	Priorities > 0 should be preemptive.
189 **
190 **	MsgPriority is the number of bytes in the message adjusted
191 **	by the message priority and the amount of time the message
192 **	has been sitting around.  Each priority point is worth
193 **	WKPRIFACT bytes of message, and each time we reprocess a
194 **	message the size gets reduced by WKTIMEFACT.
195 */
196 
197 # define PRI_ALERT	20
198 # define PRI_QUICK	10
199 # define PRI_FIRSTCL	3
200 # define PRI_NORMAL	0
201 # define PRI_SECONDCL	-10
202 # define PRI_THIRDCL	-20
203 
204 # define WKPRIFACT	1800		/* bytes each pri point is worth */
205 # define WKTIMEFACT	400		/* bytes each time unit is worth */
206 
207 EXTERN long	MsgPriority;		/* adjusted priority of this message */
208 
209 
210 
211 /*
212 **  Rewrite rules.
213 */
214 
215 struct rewrite
216 {
217 	char	**r_lhs;	/* pattern match */
218 	char	**r_rhs;	/* substitution value */
219 	struct rewrite	*r_next;/* next in chain */
220 };
221 
222 extern struct rewrite	*RewriteRules[];
223 
224 # define MATCHANY	'\020'	/* match one or more tokens */
225 # define MATCHONE	'\021'	/* match exactly one token */
226 # define MATCHCLASS	'\022'	/* match one token in a class */
227 # define MATCHREPL	'\023'	/* replacement on RHS for above */
228 
229 # define CANONNET	'\025'	/* canonical net, next token */
230 # define CANONHOST	'\026'	/* canonical host, next token */
231 # define CANONUSER	'\027'	/* canonical user, next N tokens */
232 
233 
234 
235 /*
236 **  Symbol table definitions
237 */
238 
239 struct symtab
240 {
241 	char		*s_name;	/* name to be entered */
242 	char		s_type;		/* general type (see below) */
243 	struct symtab	*s_next;	/* pointer to next in chain */
244 	union
245 	{
246 		long	sv_class;	/* bit-map of word classes */
247 		ADDRESS	*sv_addr;	/* pointer to address header */
248 		MAILER	*sv_mailer;	/* pointer to mailer */
249 		char	*sv_alias;	/* alias */
250 	}	s_value;
251 };
252 
253 typedef struct symtab	STAB;
254 
255 /* symbol types */
256 # define ST_UNDEF	0	/* undefined type */
257 # define ST_CLASS	1	/* class map */
258 # define ST_ADDRESS	2	/* an address in parsed format */
259 # define ST_MAILER	3	/* a mailer header */
260 # define ST_ALIAS	4	/* an alias */
261 
262 # define s_class	s_value.sv_class
263 # define s_addr		s_value.sv_addr
264 # define s_mailer	s_value.sv_mailer
265 # define s_alias	s_value.sv_alias
266 
267 extern STAB	*stab();
268 
269 /* opcodes to stab */
270 # define ST_FIND	0	/* find entry */
271 # define ST_ENTER	1	/* enter if not there */
272 
273 
274 
275 
276 /*
277 **  Statistics structure.
278 */
279 
280 struct statistics
281 {
282 	time_t	stat_itime;		/* file initialization time */
283 	short	stat_size;		/* size of this structure */
284 	long	stat_nf[MAXMAILERS];	/* # msgs from each mailer */
285 	long	stat_bf[MAXMAILERS];	/* kbytes from each mailer */
286 	long	stat_nt[MAXMAILERS];	/* # msgs to each mailer */
287 	long	stat_bt[MAXMAILERS];	/* kbytes to each mailer */
288 };
289 
290 EXTERN struct statistics	Stat;
291 extern long			kbytes();	/* for _bf, _bt */
292 
293 
294 
295 
296 /*
297 **  Global variables.
298 */
299 
300 EXTERN bool	FromFlag;	/* if set, "From" person is explicit */
301 EXTERN bool	MailBack;	/* mail back response on error */
302 EXTERN bool	BerkNet;	/* called from BerkNet */
303 EXTERN bool	WriteBack;	/* write back response on error */
304 EXTERN bool	NoAlias;	/* if set, don't do any aliasing */
305 EXTERN bool	ForceMail;	/* if set, mail even if already got a copy */
306 EXTERN bool	MeToo;		/* send to the sender also */
307 EXTERN bool	IgnrDot;	/* don't let dot end messages */
308 EXTERN bool	SaveFrom;	/* save leading "From" lines */
309 EXTERN bool	Verbose;	/* set if blow-by-blow desired */
310 EXTERN bool	GrabTo;		/* if set, get recipients from msg */
311 EXTERN bool	DontSend;	/* mark recipients as QDONTSEND */
312 EXTERN bool	NoReturn;	/* don't return letter to sender */
313 EXTERN bool	Daemon;		/* running as a daemon */
314 EXTERN bool	Smtp;		/* using SMTP over connection */
315 EXTERN bool	SuprErrs;	/* set if we are suppressing errors */
316 EXTERN bool	QueueUp;	/* queue this message for future xmission */
317 EXTERN bool	QueueRun;	/* currently running something from the queue */
318 EXTERN bool	HoldErrs;	/* only output errors to transcript */
319 EXTERN bool	ArpaMode;	/* set if running arpanet protocol */
320 extern time_t	TimeOut;	/* time until timeout */
321 EXTERN FILE	*InChannel;	/* input connection */
322 EXTERN FILE	*OutChannel;	/* output connection */
323 EXTERN FILE	*TempFile;	/* mail temp file */
324 EXTERN FILE	*Xscript;	/* mail transcript file */
325 EXTERN int	RealUid;	/* when Daemon, real uid of caller */
326 EXTERN int	RealGid;	/* when Daemon, real gid of caller */
327 EXTERN int	OldUmask;	/* umask when sendmail starts up */
328 EXTERN int	Debug;		/* debugging level */
329 EXTERN int	Errors;		/* set if errors */
330 EXTERN int	ExitStat;	/* exit status code */
331 EXTERN int	HopCount;	/* hop count */
332 EXTERN int	AliasLevel;	/* depth of aliasing */
333 EXTERN time_t	QueueIntvl;	/* intervals between running the queue */
334 EXTERN char	*OrigFrom;	/* the From: line read from the message */
335 EXTERN char	*To;		/* the target person */
336 EXTERN char	*HostName;	/* name of this host for SMTP messages */
337 EXTERN char	*InFileName;	/* input file name */
338 EXTERN char	*Transcript;	/* the transcript file name */
339 extern char	*XcriptFile;	/* template for Transcript */
340 extern char	*AliasFile;	/* location of alias file */
341 extern char	*ConfFile;	/* location of configuration file */
342 extern char	*StatFile;	/* location of statistics summary */
343 extern char	*QueueDir;	/* location of queue directory */
344 EXTERN ADDRESS	From;		/* the person it is from */
345 EXTERN ADDRESS	*SendQueue;	/* list of message recipients */
346 EXTERN long	MsgSize;	/* size of the message in bytes */
347 EXTERN time_t	CurTime;	/* time of this message */
348 
349 
350 # include	<sysexits.h>
351 
352 # define setstat(s)		{ if (ExitStat == EX_OK) ExitStat = s; }
353 
354 
355 /* useful functions */
356 
357 extern char	*newstr();
358 extern ADDRESS	*parse();
359 extern char	*xalloc();
360 extern char	*expand();
361 extern bool	sameaddr();
362