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