xref: /netbsd-src/usr.bin/mail/def.h (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1 /*	$NetBSD: def.h,v 1.15 2002/03/29 15:07:52 ross Exp $	*/
2 /*
3  * Copyright (c) 1980, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by the University of
17  *	California, Berkeley and its contributors.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)def.h	8.4 (Berkeley) 4/20/95
35  *	$NetBSD: def.h,v 1.15 2002/03/29 15:07:52 ross Exp $
36  */
37 
38 /*
39  * Mail -- a mail program
40  *
41  * Author: Kurt Shoens (UCB) March 25, 1978
42  */
43 
44 #include <sys/types.h>
45 #include <sys/file.h>
46 #include <sys/ioctl.h>
47 #include <sys/stat.h>
48 #include <sys/param.h>
49 #include <sys/time.h>
50 #include <sys/wait.h>
51 
52 #include <ctype.h>
53 #include <err.h>
54 #include <errno.h>
55 #include <fcntl.h>
56 #include <paths.h>
57 #include <pwd.h>
58 #include <signal.h>
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 #include <termios.h>
63 #include <time.h>
64 #include <unistd.h>
65 #include "pathnames.h"
66 
67 #define	APPEND				/* New mail goes to end of mailbox */
68 
69 #define	ESCAPE		'~'		/* Default escape for sending */
70 #define	NMLSIZE		1024		/* max names in a message list */
71 #define	PATHSIZE	MAXPATHLEN	/* Size of pathnames throughout */
72 #define	HSHSIZE		59		/* Hash size for aliases and vars */
73 #define	LINESIZE	BUFSIZ		/* max readable line width */
74 #define	STRINGSIZE	((unsigned) 128)/* Dynamic allocation units */
75 #define	MAXARGC		1024		/* Maximum list of raw strings */
76 #define	MAXEXP		25		/* Maximum expansion of aliases */
77 
78 #define	equal(a, b)	(strcmp(a,b)==0)/* A nice function to string compare */
79 
80 struct message {
81 	short	m_flag;			/* flags, see below */
82 	long	m_block;		/* block number of this message */
83 	short	m_offset;		/* offset in block of message */
84 	long	m_size;			/* Bytes in the message */
85 	long	m_lines;		/* Lines in the message */
86 	long	m_blines;		/* Body (non-header) lines */
87 };
88 
89 /*
90  * flag bits.
91  */
92 
93 #define	MUSED		(1<<0)		/* entry is used, but this bit isn't */
94 #define	MDELETED	(1<<1)		/* entry has been deleted */
95 #define	MSAVED		(1<<2)		/* entry has been saved */
96 #define	MTOUCH		(1<<3)		/* entry has been noticed */
97 #define	MPRESERVE	(1<<4)		/* keep entry in sys mailbox */
98 #define	MMARK		(1<<5)		/* message is marked! */
99 #define	MODIFY		(1<<6)		/* message has been modified */
100 #define	MNEW		(1<<7)		/* message has never been seen */
101 #define	MREAD		(1<<8)		/* message has been read sometime. */
102 #define	MSTATUS		(1<<9)		/* message status has changed */
103 #define	MBOX		(1<<10)		/* Send this to mbox, regardless */
104 
105 /*
106  * Given a file address, determine the block number it represents.
107  */
108 #define blockof(off)			((int) ((off) / 4096))
109 #define offsetof(off)			((int) ((off) % 4096))
110 #define positionof(block, offset)	((off_t)(block) * 4096 + (offset))
111 
112 /*
113  * Format of the command description table.
114  * The actual table is declared and initialized
115  * in lex.c
116  */
117 struct cmd {
118 	char	*c_name;		/* Name of command */
119 	int	(*c_func)(void *);	/* Implementor of the command */
120 	short	c_argtype;		/* Type of arglist (see below) */
121 	short	c_msgflag;		/* Required flags of messages */
122 	short	c_msgmask;		/* Relevant flags of messages */
123 };
124 
125 /* Yechh, can't initialize unions */
126 
127 #define	c_minargs c_msgflag		/* Minimum argcount for RAWLIST */
128 #define	c_maxargs c_msgmask		/* Max argcount for RAWLIST */
129 
130 /*
131  * Argument types.
132  */
133 
134 #define	MSGLIST	 0		/* Message list type */
135 #define	STRLIST	 1		/* A pure string */
136 #define	RAWLIST	 2		/* Shell string list */
137 #define	NOLIST	 3		/* Just plain 0 */
138 #define	NDMLIST	 4		/* Message list, no defaults */
139 
140 #define	P	040		/* Autoprint dot after command */
141 #define	I	0100		/* Interactive command bit */
142 #define	M	0200		/* Legal from send mode bit */
143 #define	W	0400		/* Illegal when read only bit */
144 #define	F	01000		/* Is a conditional command */
145 #define	T	02000		/* Is a transparent command */
146 #define	R	04000		/* Cannot be called from collect */
147 
148 /*
149  * Oft-used mask values
150  */
151 
152 #define	MMNORM		(MDELETED|MSAVED)/* Look at both save and delete bits */
153 #define	MMNDEL		MDELETED	/* Look only at deleted bit */
154 
155 /*
156  * Structure used to return a break down of a head
157  * line (hats off to Bill Joy!)
158  */
159 
160 struct headline {
161 	char	*l_from;	/* The name of the sender */
162 	char	*l_tty;		/* His tty string (if any) */
163 	char	*l_date;	/* The entire date string */
164 };
165 
166 #define	GTO	1		/* Grab To: line */
167 #define	GSUBJECT 2		/* Likewise, Subject: line */
168 #define	GCC	4		/* And the Cc: line */
169 #define	GBCC	8		/* And also the Bcc: line */
170 #define	GMASK	(GTO|GSUBJECT|GCC|GBCC)
171 				/* Mask of places from whence */
172 
173 #define	GNL	16		/* Print blank line after */
174 #define	GDEL	32		/* Entity removed from list */
175 #define	GCOMMA	64		/* detract puts in commas */
176 
177 /*
178  * Structure used to pass about the current
179  * state of the user-typed message header.
180  */
181 
182 struct header {
183 	struct name *h_to;		/* Dynamic "To:" string */
184 	char *h_subject;		/* Subject string */
185 	struct name *h_cc;		/* Carbon copies string */
186 	struct name *h_bcc;		/* Blind carbon copies */
187 	struct name *h_smopts;		/* Sendmail options */
188 };
189 
190 /*
191  * Structure of namelist nodes used in processing
192  * the recipients of mail and aliases and all that
193  * kind of stuff.
194  */
195 
196 struct name {
197 	struct	name *n_flink;		/* Forward link in list. */
198 	struct	name *n_blink;		/* Backward list link */
199 	short	n_type;			/* From which list it came */
200 	char	*n_name;		/* This fella's name */
201 };
202 
203 /*
204  * Structure of a variable node.  All variables are
205  * kept on a singly-linked list of these, rooted by
206  * "variables"
207  */
208 
209 struct var {
210 	struct	var *v_link;		/* Forward link to next variable */
211 	char	*v_name;		/* The variable's name */
212 	char	*v_value;		/* And it's current value */
213 };
214 
215 struct group {
216 	struct	group *ge_link;		/* Next person in this group */
217 	char	*ge_name;		/* This person's user name */
218 };
219 
220 struct grouphead {
221 	struct	grouphead *g_link;	/* Next grouphead in list */
222 	char	*g_name;		/* Name of this group */
223 	struct	group *g_list;		/* Users in group. */
224 };
225 
226 /*
227  * Structure of the hash table of ignored header fields
228  */
229 struct ignoretab {
230 	int i_count;			/* Number of entries */
231 	struct ignore {
232 		struct ignore *i_link;	/* Next ignored field in bucket */
233 		char *i_field;		/* This ignored field */
234 	} *i_head[HSHSIZE];
235 };
236 
237 /*
238  * Token values returned by the scanner used for argument lists.
239  * Also, sizes of scanner-related things.
240  */
241 
242 #define	TEOL	0			/* End of the command line */
243 #define	TNUMBER	1			/* A message number */
244 #define	TDASH	2			/* A simple dash */
245 #define	TSTRING	3			/* A string (possibly containing -) */
246 #define	TDOT	4			/* A "." */
247 #define	TUP	5			/* An "^" */
248 #define	TDOLLAR	6			/* A "$" */
249 #define	TSTAR	7			/* A "*" */
250 #define	TOPEN	8			/* An '(' */
251 #define	TCLOSE	9			/* A ')' */
252 #define TPLUS	10			/* A '+' */
253 #define TERROR	11			/* A lexical error */
254 
255 #define	REGDEP	2			/* Maximum regret depth. */
256 #define	STRINGLEN	1024		/* Maximum length of string token */
257 
258 /*
259  * Constants for conditional commands.  These describe whether
260  * we should be executing stuff or not.
261  */
262 
263 #define	CANY		0		/* Execute in send or receive mode */
264 #define	CRCV		1		/* Execute in receive mode only */
265 #define	CSEND		2		/* Execute in send mode only */
266 
267 /*
268  * Kludges to handle the change from setexit / reset to setjmp / longjmp
269  */
270 
271 #define	setexit()	setjmp(srbuf)
272 #define	reset(x)	longjmp(srbuf, x)
273 
274 /*
275  * Truncate a file to the last character written. This is
276  * useful just before closing an old file that was opened
277  * for read/write.
278  */
279 #define trunc(stream) {							\
280 	(void)fflush(stream); 						\
281 	(void)ftruncate(fileno(stream), (off_t)ftell(stream));		\
282 }
283