xref: /netbsd-src/usr.bin/mail/def.h (revision d9158b13b5dfe46201430699a3f7a235ecf28df3)
1 /*
2  * Copyright (c) 1980 Regents of the University of California.
3  * 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  *	from: @(#)def.h	5.22 (Berkeley) 6/25/90
34  *	$Id: def.h,v 1.5 1994/05/07 01:09:56 jtc Exp $
35  */
36 
37 #include <sys/param.h>		/* includes <sys/types.h> */
38 #include <sys/signal.h>
39 #include <stdio.h>
40 #include <sgtty.h>
41 #include <ctype.h>
42 #include <string.h>
43 #include "pathnames.h"
44 
45 /*
46  * Mail -- a mail program
47  *
48  * Author: Kurt Shoens (UCB) March 25, 1978
49  */
50 
51 #define	APPEND				/* New mail goes to end of mailbox */
52 
53 #define	ESCAPE		'~'		/* Default escape for sending */
54 #define	NMLSIZE		1024		/* max names in a message list */
55 #define	PATHSIZE	MAXPATHLEN	/* Size of pathnames throughout */
56 #define	HSHSIZE		59		/* Hash size for aliases and vars */
57 #define	LINESIZE	BUFSIZ		/* max readable line width */
58 #define	STRINGSIZE	((unsigned) 128)/* Dynamic allocation units */
59 #define	MAXARGC		1024		/* Maximum list of raw strings */
60 #define	NOSTR		((char *) 0)	/* Null string pointer */
61 #define	MAXEXP		25		/* Maximum expansion of aliases */
62 
63 #define	equal(a, b)	(strcmp(a,b)==0)/* A nice function to string compare */
64 
65 struct message {
66 	short	m_flag;			/* flags, see below */
67 	short	m_block;		/* block number of this message */
68 	short	m_offset;		/* offset in block of message */
69 	long	m_size;			/* Bytes in the message */
70 	short	m_lines;		/* Lines in the message */
71 };
72 
73 /*
74  * flag bits.
75  */
76 
77 #define	MUSED		(1<<0)		/* entry is used, but this bit isn't */
78 #define	MDELETED	(1<<1)		/* entry has been deleted */
79 #define	MSAVED		(1<<2)		/* entry has been saved */
80 #define	MTOUCH		(1<<3)		/* entry has been noticed */
81 #define	MPRESERVE	(1<<4)		/* keep entry in sys mailbox */
82 #define	MMARK		(1<<5)		/* message is marked! */
83 #define	MODIFY		(1<<6)		/* message has been modified */
84 #define	MNEW		(1<<7)		/* message has never been seen */
85 #define	MREAD		(1<<8)		/* message has been read sometime. */
86 #define	MSTATUS		(1<<9)		/* message status has changed */
87 #define	MBOX		(1<<10)		/* Send this to mbox, regardless */
88 
89 /*
90  * Given a file address, determine the block number it represents.
91  */
92 #define blockof(off)			((int) ((off) / 4096))
93 #define offsetof(off)			((int) ((off) % 4096))
94 #define positionof(block, offset)	((off_t)(block) * 4096 + (offset))
95 
96 /*
97  * Format of the command description table.
98  * The actual table is declared and initialized
99  * in lex.c
100  */
101 
102 struct cmd {
103 	char	*c_name;		/* Name of command */
104 	int	(*c_func)();		/* Implementor of the command */
105 	short	c_argtype;		/* Type of arglist (see below) */
106 	short	c_msgflag;		/* Required flags of messages */
107 	short	c_msgmask;		/* Relevant flags of messages */
108 };
109 
110 /* Yechh, can't initialize unions */
111 
112 #define	c_minargs c_msgflag		/* Minimum argcount for RAWLIST */
113 #define	c_maxargs c_msgmask		/* Max argcount for RAWLIST */
114 
115 /*
116  * Argument types.
117  */
118 
119 #define	MSGLIST	 0		/* Message list type */
120 #define	STRLIST	 1		/* A pure string */
121 #define	RAWLIST	 2		/* Shell string list */
122 #define	NOLIST	 3		/* Just plain 0 */
123 #define	NDMLIST	 4		/* Message list, no defaults */
124 
125 #define	P	040		/* Autoprint dot after command */
126 #define	I	0100		/* Interactive command bit */
127 #define	M	0200		/* Legal from send mode bit */
128 #define	W	0400		/* Illegal when read only bit */
129 #define	F	01000		/* Is a conditional command */
130 #define	T	02000		/* Is a transparent command */
131 #define	R	04000		/* Cannot be called from collect */
132 
133 /*
134  * Oft-used mask values
135  */
136 
137 #define	MMNORM		(MDELETED|MSAVED)/* Look at both save and delete bits */
138 #define	MMNDEL		MDELETED	/* Look only at deleted bit */
139 
140 /*
141  * Structure used to return a break down of a head
142  * line (hats off to Bill Joy!)
143  */
144 
145 struct headline {
146 	char	*l_from;	/* The name of the sender */
147 	char	*l_tty;		/* His tty string (if any) */
148 	char	*l_date;	/* The entire date string */
149 };
150 
151 #define	GTO	1		/* Grab To: line */
152 #define	GSUBJECT 2		/* Likewise, Subject: line */
153 #define	GCC	4		/* And the Cc: line */
154 #define	GBCC	8		/* And also the Bcc: line */
155 #define	GMASK	(GTO|GSUBJECT|GCC|GBCC)
156 				/* Mask of places from whence */
157 
158 #define	GNL	16		/* Print blank line after */
159 #define	GDEL	32		/* Entity removed from list */
160 #define	GCOMMA	64		/* detract puts in commas */
161 
162 /*
163  * Structure used to pass about the current
164  * state of the user-typed message header.
165  */
166 
167 struct header {
168 	struct name *h_to;		/* Dynamic "To:" string */
169 	char *h_subject;		/* Subject string */
170 	struct name *h_cc;		/* Carbon copies string */
171 	struct name *h_bcc;		/* Blind carbon copies */
172 	struct name *h_smopts;		/* Sendmail options */
173 };
174 
175 /*
176  * Structure of namelist nodes used in processing
177  * the recipients of mail and aliases and all that
178  * kind of stuff.
179  */
180 
181 struct name {
182 	struct	name *n_flink;		/* Forward link in list. */
183 	struct	name *n_blink;		/* Backward list link */
184 	short	n_type;			/* From which list it came */
185 	char	*n_name;		/* This fella's name */
186 };
187 
188 /*
189  * Structure of a variable node.  All variables are
190  * kept on a singly-linked list of these, rooted by
191  * "variables"
192  */
193 
194 struct var {
195 	struct	var *v_link;		/* Forward link to next variable */
196 	char	*v_name;		/* The variable's name */
197 	char	*v_value;		/* And it's current value */
198 };
199 
200 struct group {
201 	struct	group *ge_link;		/* Next person in this group */
202 	char	*ge_name;		/* This person's user name */
203 };
204 
205 struct grouphead {
206 	struct	grouphead *g_link;	/* Next grouphead in list */
207 	char	*g_name;		/* Name of this group */
208 	struct	group *g_list;		/* Users in group. */
209 };
210 
211 #define	NIL	((struct name *) 0)	/* The nil pointer for namelists */
212 #define	NONE	((struct cmd *) 0)	/* The nil pointer to command tab */
213 #define	NOVAR	((struct var *) 0)	/* The nil pointer to variables */
214 #define	NOGRP	((struct grouphead *) 0)/* The nil grouphead pointer */
215 #define	NOGE	((struct group *) 0)	/* The nil group pointer */
216 
217 /*
218  * Structure of the hash table of ignored header fields
219  */
220 struct ignoretab {
221 	int i_count;			/* Number of entries */
222 	struct ignore {
223 		struct ignore *i_link;	/* Next ignored field in bucket */
224 		char *i_field;		/* This ignored field */
225 	} *i_head[HSHSIZE];
226 };
227 
228 /*
229  * Token values returned by the scanner used for argument lists.
230  * Also, sizes of scanner-related things.
231  */
232 
233 #define	TEOL	0			/* End of the command line */
234 #define	TNUMBER	1			/* A message number */
235 #define	TDASH	2			/* A simple dash */
236 #define	TSTRING	3			/* A string (possibly containing -) */
237 #define	TDOT	4			/* A "." */
238 #define	TUP	5			/* An "^" */
239 #define	TDOLLAR	6			/* A "$" */
240 #define	TSTAR	7			/* A "*" */
241 #define	TOPEN	8			/* An '(' */
242 #define	TCLOSE	9			/* A ')' */
243 #define TPLUS	10			/* A '+' */
244 #define TERROR	11			/* A lexical error */
245 
246 #define	REGDEP	2			/* Maximum regret depth. */
247 #define	STRINGLEN	1024		/* Maximum length of string token */
248 
249 /*
250  * Constants for conditional commands.  These describe whether
251  * we should be executing stuff or not.
252  */
253 
254 #define	CANY		0		/* Execute in send or receive mode */
255 #define	CRCV		1		/* Execute in receive mode only */
256 #define	CSEND		2		/* Execute in send mode only */
257 
258 /*
259  * Kludges to handle the change from setexit / reset to setjmp / longjmp
260  */
261 
262 #define	setexit()	setjmp(srbuf)
263 #define	reset(x)	longjmp(srbuf, x)
264 
265 /*
266  * Truncate a file to the last character written. This is
267  * useful just before closing an old file that was opened
268  * for read/write.
269  */
270 #define trunc(stream) {						\
271 	(void)fflush(stream);					\
272 	(void)ftruncate(fileno(stream), (off_t)ftell(stream));	\
273 }
274 
275 /*
276  * Forward declarations of routine types to keep lint and cc happy.
277  */
278 
279 FILE	*Fopen();
280 FILE	*Fdopen();
281 FILE	*Popen();
282 FILE	*collect();
283 FILE	*infix();
284 FILE	*run_editor();
285 FILE	*setinput();
286 char	**unpack();
287 char	*calloc();
288 char	*copy();
289 char	*copyin();
290 char	*detract();
291 char	*expand();
292 char	*getdeadletter();
293 char	*gets();
294 char	*hfield();
295 char	*name1();
296 char	*nameof();
297 char	*nextword();
298 char	*getenv();
299 char	*getname();
300 char	*fgets();
301 char	*ishfield();
302 char	*malloc();
303 char	*mktemp();
304 char	*readtty();
305 char	*reedit();
306 char	*salloc();
307 char	*savestr();
308 char	*skin();
309 char	*snarf();
310 char	*username();
311 char	*value();
312 char	*vcopy();
313 char	*yankword();
314 off_t	fsize();
315 uid_t	getuid();
316 struct	cmd	*lex();
317 struct	grouphead	*findgroup();
318 struct	name	*nalloc();
319 struct	name	*cat();
320 struct	name	*delname();
321 struct	name	*elide();
322 struct	name	*extract();
323 struct	name	*gexpand();
324 struct	name	*outof();
325 struct	name	*put();
326 struct	name	*usermap();
327 struct	var	*lookup();
328