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