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