/usr.bin/mail/def.h

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