1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
2 *@ Header inclusion, macros, constants, types and the global var declarations.
4 * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
5 * Copyright (c) 2012 - 2013 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
8 * Copyright (c) 1980, 1993
9 * The Regents of the University of California. All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 * Mail -- a mail program
43 * Author: Kurt Shoens (UCB) March 25, 1978
49 #include <sys/types.h>
63 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
66 # include <inttypes.h>
81 * CC support, generic macros etc.
85 #if defined __GNUC__ || defined __clang__
86 # define __EXTEN __extension__
88 # define __PREREQ(X,Y) \
89 (__GNUC__ > (X) || (__GNUC__ == (X) && __GNUC_MINOR__ >= (Y)))
91 # define __PREREQ(X,Y) 1
95 # define __PREREQ(X,Y) 0
98 #define EMPTY_FILE(F) typedef int CONCAT(avoid_empty_file__, F);
100 /* Pointer to size_t */
101 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
103 /* Pointer comparison (types from below) */
104 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
106 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
107 * Note: doesn't sign-extend correctly, that's still up to the caller */
108 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
110 /* Members in constant array */
112 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
115 /* sizeof() for member fields */
116 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
118 /* Casts-away (*NOT* cast-away) */
119 #define UNUSED(X) ((void)(X))
120 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
121 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
122 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
124 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
125 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
126 # define STRING(X) #X
127 # define XSTRING(X) STRING(X)
128 # define CONCAT(S1,S2) _CONCAT(S1, S2)
129 # define _CONCAT(S1,S2) S1 ## S2
131 # define STRING(X) "X"
132 # define XSTRING STRING
133 # define CONCAT(S1,S2) S1/**/S2
136 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
137 /* Variable size arrays and structure fields */
138 # define VFIELD_SIZE(X)
139 # define VFIELD_SIZEOF(T,F) (0)
140 /* Inline functions */
142 # define INLINE inline
143 # define SINLINE static inline
145 # define VFIELD_SIZE(X) (X)
146 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
148 # define INLINE static __inline
149 # define SINLINE static __inline
152 # define SINLINE static
156 #if defined __predict_true && defined __predict_false
157 # define LIKELY(X) __predict_true(X)
158 # define UNLIKELY(X) __predict_false(X)
159 #elif __PREREQ(2, 96)
160 # define LIKELY(X) __builtin_expect(X, 1)
161 # define UNLIKELY(X) __builtin_expect(X, 0)
163 # define LIKELY(X) (X)
164 # define UNLIKELY(X) (X)
167 /* Compile-Time-Assert */
168 #define CTA(TEST) _CTA_1(TEST, __LINE__)
169 #define _CTA_1(TEST,L) _CTA_2(TEST, L)
170 #define _CTA_2(TEST,L) \
171 typedef char COMPILE_TIME_ASSERT_failed_at_line_ ## L[(TEST) ? 1 : -1]
174 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
176 #define MIN(A, B) ((A) < (B) ? (A) : (B))
178 #define MAX(A, B) ((A) < (B) ? (B) : (A))
180 #define ABS(A) ((A) < 0 ? -(A) : (A))
186 # define assert(X) UNUSED(0)
194 /* Translation (init in main.c) */
198 # define tr(c,d) catgets(catd, CATSET, c, d)
204 * Constants, some nail-specific macros
207 #if !defined NI_MAXHOST || NI_MAXHOST < 1025
209 # define NI_MAXHOST 1025
214 # define MAXPATHLEN PATH_MAX
216 # define MAXPATHLEN 1024
218 #elif defined PATH_MAX && MAXPATHLEN < PATH_MAX
220 # define MAXPATHLEN PATH_MAX
224 # define STDIN_FILENO 0
226 #ifndef STDOUT_FILENO
227 # define STDOUT_FILENO 1
229 #ifndef STDERR_FILENO
230 # define STDERR_FILENO 2
235 # define NSIG NSIG_MAX
237 # define NSIG ((sizeof(sigset_t) * 8) - 1)
242 #if BUFSIZ > 2560 /* TODO simply use BUFSIZ? */
243 # define LINESIZE BUFSIZ /* max readable line width */
245 # define LINESIZE 2560
247 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
249 #define CBAD (-15555)
250 #define APPEND /* New mail goes to end of mailbox */
251 #define ESCAPE '~' /* Default escape for sending */
252 #define HIST_SIZE 242 /* tty.c: history list default size */
253 #define HSHSIZE 23 /* Hash prime (aliases, vars, macros) */
254 #define MAXARGC 1024 /* Maximum list of raw strings */
255 #define MAXEXP 25 /* Maximum expansion of aliases */
256 #define PROMPT_BUFFER_SIZE 80 /* getprompt() bufsize (> 3!) */
258 #define ACCOUNT_NULL "null" /* Name of "null" account */
259 #define MAILRC "~/.mailrc"
260 #define TMPDIR_FALLBACK "/tmp"
262 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
263 #define DATE_DAYSYEAR 365L
264 #define DATE_SECSMIN 60L
265 #define DATE_MINSHOUR 60L
266 #define DATE_HOURSDAY 24L
267 #define DATE_SECSDAY (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
269 /* Default *encoding* as enum conversion below */
270 #define MIME_DEFAULT_ENCODING CONV_TOQP
272 /* Maximum allowed line length in a mail before QP folding is necessary), and
273 * the real limit we go for */
274 #define MIME_LINELEN_MAX 1000
275 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 50)
277 /* Locations of mime.types(5) */
278 #define MIME_TYPES_USR "~/.mime.types"
279 #define MIME_TYPES_SYS "/etc/mime.types"
281 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set */
282 #define CHARSET_7BIT "US-ASCII"
284 # define CHARSET_8BIT "UTF-8"
285 # define CHARSET_8BIT_VAR "charset-8bit"
287 # define CHARSET_8BIT "ISO-8859-1"
288 # define CHARSET_8BIT_VAR "ttycharset"
291 /* Is *W* a quoting (ASCII only) character? */
293 ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
295 /* Maximum number of quote characters (not bytes!) that'll be used on
296 * follow lines when compressing leading quote characters */
299 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
300 #define QUOTE_TAB_SPACES 8
302 /* Maximum size of a message that is passed through to the spam system */
303 #define SPAM_MAXSIZE 420000
305 /* String dope: dynamic buffer size, and size of the single builtin one that's
307 #define SBUFFER_SIZE 0x18000u
308 #define SBUFFER_BUILTIN 0x2000u
310 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
312 # define XSHELL "/bin/sh"
316 # define XLISTER "ls"
318 #define LISTER XLISTER
320 # define XPAGER "more"
328 /* TODO convert all integer types to the new [su]i(8|16|32|64)_t */
329 typedef unsigned long ul_it
;
330 typedef unsigned int ui_it
;
331 typedef unsigned short us_it
;
332 typedef unsigned char uc_it
;
334 typedef signed long sl_it
;
335 typedef signed int si_it
;
336 typedef signed short ss_it
;
337 typedef signed char sc_it
;
340 # define UI8_MAX UINT8_MAX
341 # define SI8_MIN INT8_MIN
342 # define SI8_MAX INT8_MAX
343 typedef uint8_t ui8_t
;
344 typedef int8_t si8_t
;
345 #elif UCHAR_MAX != 255
346 # error UCHAR_MAX must be 255
348 # define UI8_MAX UCHAR_MAX
349 # define SI8_MIN CHAR_MIN
350 # define SI8_MAX CHAR_MAX
351 typedef unsigned char ui8_t
;
352 typedef signed char si8_t
;
356 # define UI16_MAX UINT16_MAX
357 # define SI16_MIN INT16_MIN
358 # define SI16_MAX INT16_MAX
359 typedef uint16_t ui16_t
;
360 typedef int16_t si16_t
;
361 #elif USHRT_MAX != 0xFFFFu
362 # error USHRT_MAX must be 0xFFFF
364 # define UI16_MAX USHRT_MAX
365 # define SI16_MIN SHRT_MIN
366 # define SI16_MAX SHRT_MAX
367 typedef unsigned short ui16_t
;
368 typedef signed short si16_t
;
372 # define UI32_MAX UINT32_MAX
373 # define SI32_MIN INT32_MIN
374 # define SI32_MAX INT32_MAX
375 typedef uint32_t ui32_t
;
376 typedef int32_t si32_t
;
377 #elif ULONG_MAX == 0xFFFFFFFFu
378 # define UI32_MAX ULONG_MAX
379 # define SI32_MIN LONG_MIN
380 # define SI32_MAX LONG_MAX
381 typedef unsigned long int ui32_t
;
382 typedef signed long int si32_t
;
383 #elif UINT_MAX != 0xFFFFFFFFu
384 # error UINT_MAX must be 0xFFFFFFFF
386 # define UI32_MAX UINT_MAX
387 # define SI32_MIN INT_MIN
388 # define SI32_MAX INT_MAX
389 typedef unsigned int ui32_t
;
390 typedef signed int si32_t
;
394 # define UI64_MAX UINT64_MAX
395 # define SI64_MIN INT64_MIN
396 # define SI64_MAX INT64_MAX
397 typedef uint64_t ui64_t
;
398 #elif ULONG_MAX <= 0xFFFFFFFFu
399 # if !defined ULLONG_MAX || ULLONG_MAX != 0xFFFFFFFFFFFFFFFFu
400 # error We need a 64 bit integer
402 # define UI64_MAX ULLONG_MAX
403 # define SI64_MIN LLONG_MIN
404 # define SI64_MAX LLONG_MAX
405 __EXTEN
typedef unsigned long long ui64_t
;
406 __EXTEN
typedef signed long long si64_t
;
409 # define UI64_MAX ULONG_MAX
410 # define SI64_MIN LONG_MIN
411 # define SI64_MAX LONG_MAX
412 typedef unsigned long ui64_t
;
413 typedef signed long si64_t
;
416 /* (So that we can use UICMP() for size_t comparison, too) */
417 typedef size_t uiz_t
;
418 /*typedef ssize_t siz_t;*/
422 # define uintptr_t size_t
423 # define UINTPTR_MAX SIZE_MAX
425 # define uintptr_t unsigned long
426 # define UINTPTR_MAX ULONG_MAX
430 /* XXX Note we don't really deal with that the right way in that we pass size_t
431 * XXX arguments without casting; should do, because above we assert UINT_MAX
432 * XXX is indeed ui32_t */
433 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
435 #elif defined SIZE_MAX && SIZE_MAX == 0xFFFFFFFFu && ULONG_MAX != UINT_MAX
442 typedef enum {FAL0
, TRU1
} bool_t
;
444 typedef void ( *sighandler_type
)(int);
448 OPT_DEBUG
= 1u<< 0, /* -d / *debug* */
449 OPT_VERBOSE
= 1u<< 1, /* -v / *verbose* */
450 OPT_EXISTONLY
= 1u<< 2, /* -e */
451 OPT_HEADERSONLY
= 1u<< 3, /* -H */
452 OPT_NOSRC
= 1u<< 4, /* -n */
453 OPT_E_FLAG
= 1u<< 5, /* -E / *skipemptybody* */
454 OPT_F_FLAG
= 1u<< 6, /* -F */
455 OPT_N_FLAG
= 1u<< 7, /* -N / *header* */
456 OPT_R_FLAG
= 1u<< 8, /* -R */
457 OPT_r_FLAG
= 1u<< 9, /* -r (plus option_r_arg) */
458 OPT_t_FLAG
= 1u<<10, /* -t */
459 OPT_u_FLAG
= 1u<<11, /* -u given, or USER != getpwnam(3) */
460 OPT_TILDE_FLAG
= 1u<<12, /* -~ */
461 OPT_BATCH_FLAG
= 1u<<13, /* -# */
463 OPT_SENDMODE
= 1u<<14, /* Usage case forces send mode */
464 OPT_INTERACTIVE
= 1u<<15, /* isatty(0) */
465 OPT_TTYIN
= OPT_INTERACTIVE
,
468 #define IS_TTY_SESSION() \
469 ((options & (OPT_TTYIN | OPT_TTYOUT)) == (OPT_TTYIN | OPT_TTYOUT))
472 EXIT_OK
= EXIT_SUCCESS
,
473 EXIT_ERR
= EXIT_FAILURE
,
474 EXIT_COLL_ABORT
= 1<<1, /* Message collection was aborted */
475 EXIT_SEND_ERROR
= 1<<2 /* Unspecified send error occurred */
479 FEXP_FULL
, /* Full expansion */
480 FEXP_LOCAL
= 1<<0, /* Result must be local file/maildir */
481 FEXP_SHELL
= 1<<1, /* No folder %,#,&,+ stuff, yet sh(1) */
482 FEXP_NSHORTCUT
= 1<<2, /* Don't expand shortcuts */
483 FEXP_SILENT
= 1<<3, /* Don't print but only return errors */
484 FEXP_MULTIOK
= 1<<4 /* Expansion to many entries is ok */
489 LNED_LF_ESC
= 1<<0, /* LF can be backslash escaped */
490 LNED_HIST_ADD
= 1<<1 /* Add completed line to history */
493 /* <0 means "stop" unless *prompt* extensions are enabled. */
495 PROMPT_STOP
= -1, /* \c */
496 /* *prompt* extensions: \$, \@ etc. */
507 MIME_NONE
, /* message is not in MIME format */
508 MIME_BIN
, /* message is in binary encoding */
509 MIME_8B
, /* message is in 8bit encoding */
510 MIME_7B
, /* message is in 7bit encoding */
511 MIME_QP
, /* message is quoted-printable */
512 MIME_B64
/* message is in base64 encoding */
516 CONV_NONE
, /* no conversion */
517 CONV_7BIT
, /* no conversion, is 7bit */
518 CONV_FROMQP
, /* convert from quoted-printable */
519 CONV_TOQP
, /* convert to quoted-printable */
520 CONV_8BIT
, /* convert to 8bit (iconv) */
521 CONV_FROMB64
, /* convert from base64 */
522 CONV_FROMB64_T
, /* convert from base64/text */
523 CONV_TOB64
, /* convert to base64 */
524 CONV_FROMHDR
, /* convert from RFC1522 format */
525 CONV_TOHDR
, /* convert to RFC1522 format */
526 CONV_TOHDR_A
/* convert addresses for header */
530 SEND_MBOX
, /* no conversion to perform */
531 SEND_RFC822
, /* no conversion, no From_ line */
532 SEND_TODISP
, /* convert to displayable form */
533 SEND_TODISP_ALL
, /* same, include all MIME parts */
534 SEND_SHOW
, /* convert to 'show' command form */
535 SEND_TOSRCH
, /* convert for IMAP SEARCH */
536 SEND_TOFLTR
, /* convert for spam mail filtering */
537 SEND_TOFILE
, /* convert for saving body to a file */
538 SEND_TOPIPE
, /* convert for pipe-content/subc. */
539 SEND_QUOTE
, /* convert for quoting */
540 SEND_QUOTE_ALL
, /* same, include all MIME parts */
541 SEND_DECRYPT
/* decrypt */
545 MIME_UNKNOWN
, /* unknown content */
546 MIME_SUBHDR
, /* inside a multipart subheader */
547 MIME_822
, /* message/rfc822 content */
548 MIME_MESSAGE
, /* other message/ content */
549 MIME_TEXT_PLAIN
, /* text/plain content */
550 MIME_TEXT_HTML
, /* text/html content */
551 MIME_TEXT
, /* other text/ content */
552 MIME_ALTERNATIVE
, /* multipart/alternative content */
553 MIME_DIGEST
, /* multipart/digest content */
554 MIME_MULTI
, /* other multipart/ content */
555 MIME_PKCS7
, /* PKCS7 content */
556 MIME_DISCARD
/* content is discarded */
560 TD_NONE
, /* no display conversion */
561 TD_ISPR
= 1<<0, /* use isprint() checks */
562 TD_ICONV
= 1<<1, /* use iconv() */
563 TD_DELCTRL
= 1<<2, /* delete control characters */
566 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
567 * enum sendaction, and may thus NOT clash with their bit range!
569 _TD_EOF
= 1<<14, /* EOF seen, last round! */
570 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
574 PROTO_FILE
, /* refers to a local file */
575 PROTO_POP3
, /* is a pop3 server string */
576 PROTO_IMAP
, /* is an imap server string */
577 PROTO_MAILDIR
, /* refers to a maildir folder */
578 PROTO_UNKNOWN
/* unknown protocol */
582 enum ssl_vrfy_level
{
591 char *s
; /* the string's content */
592 size_t l
; /* the stings's length */
595 struct time_current
{
603 FILE *qf_os
; /* Output stream */
605 ui_it qf_pfix_len
; /* Length of prefix: 0: bypass */
606 ui_it qf_qfold_min
; /* Simple way: wrote prefix? */
607 #ifdef HAVE_QUOTE_FOLD
608 ui_it qf_qfold_max
; /* Otherwise: line lengths */
609 uc_it qf_state
; /* *quote-fold* state machine */
610 bool_t qf_brk_isws
; /* Breakpoint is at WS */
612 ui_it qf_wscnt
; /* Whitespace count */
613 ui_it qf_brkl
; /* Breakpoint */
614 ui_it qf_brkw
; /* Visual width, breakpoint */
615 ui_it qf_datw
; /* Current visual output line width */
616 struct str qf_dat
; /* Current visual output line */
617 struct str qf_currq
; /* Current quote, compressed */
618 mbstate_t qf_mbps
[2];
622 struct termios_state
{
623 struct termios ts_tios
;
626 bool_t ts_needs_reset
;
629 #define termios_state_reset() \
631 if (termios_state.ts_needs_reset) {\
632 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
633 termios_state.ts_needs_reset = FAL0;\
637 struct sock
{ /* data associated with a socket */
638 int s_fd
; /* file descriptor */
640 int s_use_ssl
; /* SSL is used */
642 void *s_ssl
; /* SSL object */
643 void *s_ctx
; /* SSL context object */
646 char *s_wbuf
; /* for buffered writes */
647 int s_wbufsize
; /* allocated size of s_buf */
648 int s_wbufpos
; /* position of first empty data byte */
649 char *s_rbufptr
; /* read pointer to s_rbuf */
650 int s_rsz
; /* size of last read in s_rbuf */
651 char const *s_desc
; /* description of error messages */
652 void (*s_onclose
)(void); /* execute on close */
653 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
658 MB_NONE
= 000, /* no reply expected */
659 MB_COMD
= 001, /* command reply expected */
660 MB_MULT
= 002, /* multiline reply expected */
661 MB_PREAUTH
= 004, /* not in authenticated state */
662 MB_BYE
= 010 /* may accept a BYE state */
664 FILE *mb_itf
; /* temp file with messages, read open */
665 FILE *mb_otf
; /* same, write open */
666 char *mb_sorted
; /* sort method */
668 MB_VOID
, /* no type (e. g. connection failed) */
669 MB_FILE
, /* local file */
670 MB_POP3
, /* POP3 mailbox */
671 MB_IMAP
, /* IMAP mailbox */
672 MB_MAILDIR
, /* maildir folder */
673 MB_CACHE
/* cached mailbox */
674 } mb_type
; /* type of mailbox */
676 MB_DELE
= 01, /* may delete messages in mailbox */
677 MB_EDIT
= 02 /* may edit messages in mailbox */
679 int mb_compressed
; /* is a compressed mbox file */
680 int mb_threaded
; /* mailbox has been threaded */
684 MB_UIDPLUS
= 001 /* supports IMAP UIDPLUS */
686 unsigned long mb_uidvalidity
; /* IMAP unique identifier validity */
687 char *mb_imap_account
; /* name of current IMAP account */
688 char *mb_imap_mailbox
; /* name of current IMAP mailbox */
689 char *mb_cache_directory
; /* name of cache directory */
691 struct sock mb_sock
; /* socket structure */
695 NEED_UNSPEC
, /* unspecified need, don't fetch */
696 NEED_HEADER
, /* need the header of a message */
697 NEED_BODY
/* need header and body of a message */
701 HAVE_NOTHING
, /* nothing downloaded yet */
702 HAVE_HEADER
= 01, /* header is downloaded */
703 HAVE_BODY
= 02 /* entire message is downloaded */
706 /* flag bits. Attention: Flags that are used in cache.c may not change */
708 MUSED
= (1<< 0), /* entry is used, but this bit isn't */
709 MDELETED
= (1<< 1), /* entry has been deleted */
710 MSAVED
= (1<< 2), /* entry has been saved */
711 MTOUCH
= (1<< 3), /* entry has been noticed */
712 MPRESERVE
= (1<< 4), /* keep entry in sys mailbox */
713 MMARK
= (1<< 5), /* message is marked! */
714 MODIFY
= (1<< 6), /* message has been modified */
715 MNEW
= (1<< 7), /* message has never been seen */
716 MREAD
= (1<< 8), /* message has been read sometime. */
717 MSTATUS
= (1<< 9), /* message status has changed */
718 MBOX
= (1<<10), /* Send this to mbox, regardless */
719 MNOFROM
= (1<<11), /* no From line */
720 MHIDDEN
= (1<<12), /* message is hidden to user */
721 MFULLYCACHED
= (1<<13), /* message is completely cached */
722 MBOXED
= (1<<14), /* message has been sent to mbox */
723 MUNLINKED
= (1<<15), /* message was unlinked from cache */
724 MNEWEST
= (1<<16), /* message is very new (newmail) */
725 MFLAG
= (1<<17), /* message has been flagged recently */
726 MUNFLAG
= (1<<18), /* message has been unflagged */
727 MFLAGGED
= (1<<19), /* message is `flagged' */
728 MANSWER
= (1<<20), /* message has been answered recently */
729 MUNANSWER
= (1<<21), /* message has been unanswered */
730 MANSWERED
= (1<<22), /* message is `answered' */
731 MDRAFT
= (1<<23), /* message has been drafted recently */
732 MUNDRAFT
= (1<<24), /* message has been undrafted */
733 MDRAFTED
= (1<<25), /* message is marked as `draft' */
734 MOLDMARK
= (1<<26), /* messages was marked previously */
735 MSPAM
= (1<<27) /* message is classified as spam */
737 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
738 #define MMNDEL (MDELETED | MHIDDEN)
740 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
743 enum mflag m_flag
; /* flags */
744 enum havespec m_have
; /* downloaded parts of the part */
746 ui_it m_spamscore
; /* Spam score as int, 24:8 bits */
748 int m_block
; /* block number of this part */
749 size_t m_offset
; /* offset in block of part */
750 size_t m_size
; /* Bytes in the part */
751 size_t m_xsize
; /* Bytes in the full part */
752 long m_lines
; /* Lines in the message */
753 long m_xlines
; /* Lines in the full message */
754 time_t m_time
; /* time the message was sent */
755 char const *m_from
; /* message sender */
756 struct mimepart
*m_nextpart
; /* next part at same level */
757 struct mimepart
*m_multipart
; /* parts of multipart */
758 struct mimepart
*m_parent
; /* enclosing multipart part */
759 char *m_ct_type
; /* content-type */
760 char *m_ct_type_plain
; /* content-type without specs */
761 enum mimecontent m_mimecontent
; /* same in enum */
762 char const *m_charset
; /* charset */
763 char *m_ct_transfer_enc
; /* content-transfer-encoding */
764 enum mimeenc m_mimeenc
; /* same in enum */
765 char *m_partstring
; /* part level string */
766 char *m_filename
; /* attachment filename */
770 enum mflag m_flag
; /* flags */
771 enum havespec m_have
; /* downloaded parts of the message */
773 ui_it m_spamscore
; /* Spam score as int, 24:8 bits */
775 int m_block
; /* block number of this message */
776 size_t m_offset
; /* offset in block of message */
777 size_t m_size
; /* Bytes in the message */
778 size_t m_xsize
; /* Bytes in the full message */
779 long m_lines
; /* Lines in the message */
780 long m_xlines
; /* Lines in the full message */
781 time_t m_time
; /* time the message was sent */
782 time_t m_date
; /* time in the 'Date' field */
783 unsigned m_idhash
; /* hash on Message-ID for threads */
784 struct message
*m_child
; /* first child of this message */
785 struct message
*m_younger
; /* younger brother of this message */
786 struct message
*m_elder
; /* elder brother of this message */
787 struct message
*m_parent
; /* parent of this message */
788 unsigned m_level
; /* thread level of message */
789 long m_threadpos
; /* position in threaded display */
791 unsigned long m_uid
; /* IMAP unique identifier */
793 char *m_maildir_file
; /* original maildir file of msg */
794 unsigned m_maildir_hash
; /* hash of file name in maildir sub */
795 int m_collapsed
; /* collapsed thread information */
798 /* Given a file address, determine the block number it represents */
799 #define mailx_blockof(off) ((int) ((off) / 4096))
800 #define mailx_offsetof(off) ((int) ((off) % 4096))
801 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
805 MSGLIST
= 0, /* Message list type */
806 STRLIST
= 1, /* A pure string */
807 RAWLIST
= 2, /* Shell string list */
808 NOLIST
= 3, /* Just plain 0 */
809 NDMLIST
= 4, /* Message list, no defaults */
810 ECHOLIST
= 5, /* Like raw list, but keep quote chars */
811 P
= 040, /* Autoprint dot after command */
812 I
= 0100, /* Interactive command bit */
813 M
= 0200, /* Legal from send mode bit */
814 W
= 0400, /* Illegal when read only bit */
815 F
= 01000, /* Is a conditional command */
816 T
= 02000, /* Is a transparent command */
817 R
= 04000, /* Cannot be called from collect */
818 A
= 010000 /* Needs an active mailbox */
822 GTO
= 1, /* Grab To: line */
823 GSUBJECT
= 2, /* Likewise, Subject: line */
824 GCC
= 4, /* And the Cc: line */
825 GBCC
= 8, /* And also the Bcc: line */
827 GNL
= 16, /* Print blank line after */
828 GDEL
= 32, /* Entity removed from list */
829 GCOMMA
= 64, /* detract puts in commas */
830 GUA
= 128, /* User-Agent field */
831 GMIME
= 256, /* MIME 1.0 fields */
832 GMSGID
= 512, /* a Message-ID */
834 GIDENT
= 2048, /* From:, Reply-To: and Organization: field */
835 GREF
= 4096, /* References: field */
836 GDATE
= 8192, /* Date: field */
837 GFULL
= 16384, /* include full names */
838 GSKIN
= 32768, /* skin names */
839 GEXTRA
= 65536, /* extra fields */
840 GFILES
= 131072 /* include filename addresses */
842 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
844 /* Structure used to pass about the current state of a message (header) */
846 struct name
*h_to
; /* Dynamic "To:" string */
847 char *h_subject
; /* Subject string */
848 struct name
*h_cc
; /* Carbon copies string */
849 struct name
*h_bcc
; /* Blind carbon copies */
850 struct name
*h_ref
; /* References */
851 struct attachment
*h_attach
; /* MIME attachments */
852 char *h_charset
; /* preferred charset */
853 struct name
*h_from
; /* overridden "From:" field */
854 struct name
*h_replyto
; /* overridden "Reply-To:" field */
855 struct name
*h_sender
; /* overridden "Sender:" field */
856 char *h_organization
; /* overridden "Organization:" field */
859 /* Handling of namelist nodes used in processing the recipients of mail and
860 * aliases, inspection of mail-addresses and all that kind of stuff */
862 NAME_NAME_SALLOC
= 1<< 0, /* .n_name is doped */
863 NAME_FULLNAME_SALLOC
= 1<< 1, /* .n_fullname is doped */
864 NAME_SKINNED
= 1<< 2, /* Is actually skin()ned */
865 NAME_IDNA
= 1<< 3, /* IDNA was applied */
866 NAME_ADDRSPEC_CHECKED
= 1<< 4, /* Address has been .. and */
867 NAME_ADDRSPEC_ISFILE
= 1<< 5, /* ..is a file path */
868 NAME_ADDRSPEC_ISPIPE
= 1<< 6, /* ..is a command for piping */
869 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
870 NAME_ADDRSPEC_ERR_EMPTY
= 1<< 7, /* An empty string (or NULL) */
871 NAME_ADDRSPEC_ERR_ATSEQ
= 1<< 8, /* Weird @ sequence */
872 NAME_ADDRSPEC_ERR_CHAR
= 1<< 9, /* Invalid character */
873 NAME_ADDRSPEC_ERR_IDNA
= 1<<10, /* IDNA convertion failed */
874 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
875 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
876 NAME_ADDRSPEC_ERR_IDNA
,
879 _NAME_MAXWC
= 0xFFFFF,
880 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
883 /* In the !_ERR_EMPTY case, the failing character can be queried */
884 #define NAME_ADDRSPEC_ERR_GETWC(F) \
885 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
886 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
888 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
889 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
893 struct name
*n_flink
; /* Forward link in list. */
894 struct name
*n_blink
; /* Backward list link */
895 enum gfield n_type
; /* From which list it came */
896 enum nameflags n_flags
; /* enum nameflags */
897 char *n_name
; /* This fella's name */
898 char *n_fullname
; /* Sometimes, name including comment */
902 char const *ag_input
; /* Input string as given */
903 size_t ag_ilen
; /* strlen() of input */
904 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
905 size_t ag_iaddr_aend
; /* ..and one past its end */
906 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
907 size_t ag_slen
; /* strlen() of .ag_skinned */
908 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
909 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
912 /* MIME attachments */
914 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
915 AC_FIX_OUTCS
, /* _get_lc() -> "charset=" .a_charset */
916 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
917 AC_TMPFILE
/* attachment.a_tmpf is converted */
921 struct attachment
*a_flink
; /* Forward link in list. */
922 struct attachment
*a_blink
; /* Backward list link */
923 char const *a_name
; /* file name */
924 char const *a_content_type
; /* content type */
925 char const *a_content_disposition
; /* content disposition */
926 char const *a_content_id
; /* content id */
927 char const *a_content_description
; /* content description */
928 char const *a_input_charset
; /* Interpretation depends on .a_conv */
929 char const *a_charset
; /* ... */
930 FILE *a_tmpf
; /* If AC_TMPFILE */
931 enum attach_conv a_conv
; /* User chosen conversion */
932 int a_msgno
; /* message number */
936 struct group
*ge_link
; /* Next person in this group */
937 char *ge_name
; /* This person's user name */
941 struct grouphead
*g_link
; /* Next grouphead in list */
942 char *g_name
; /* Name of this group */
943 struct group
*g_list
; /* Users in group. */
946 /* Structure of the hash table of ignored header fields */
948 int i_count
; /* Number of entries */
950 struct ignore
*i_link
; /* Next ignored field in bucket */
951 char *i_field
; /* This ignored field */
955 /* Token values returned by the scanner used for argument lists.
956 * Also, sizes of scanner-related things */
958 TEOL
= 0, /* End of the command line */
959 TNUMBER
= 1, /* A message number */
960 TDASH
= 2, /* A simple dash */
961 TSTRING
= 3, /* A string (possibly containing -) */
962 TDOT
= 4, /* A "." */
963 TUP
= 5, /* An "^" */
964 TDOLLAR
= 6, /* A "$" */
965 TSTAR
= 7, /* A "*" */
966 TOPEN
= 8, /* An '(' */
967 TCLOSE
= 9, /* A ')' */
968 TPLUS
= 10, /* A '+' */
969 TERROR
= 11, /* A lexical error */
970 TCOMMA
= 12, /* A ',' */
971 TSEMI
= 13, /* A ';' */
972 TBACK
= 14 /* A '`' */
975 #define REGDEP 2 /* Maximum regret depth. */
977 /* Constants for conditional commands. These describe whether we should be
978 * executing stuff or not */
980 CANY
= 0, /* Execute in send or receive mode */
981 CRCV
= 1, /* Execute in receive mode only */
982 CSEND
= 2, /* Execute in send mode only */
983 CTERM
= 3, /* Execute only if stdin is a tty */
984 CNONTERM
= 4 /* Execute only if stdin not tty */
987 /* For the 'shortcut' and 'unshortcut' functionality */
989 struct shortcut
*sh_next
; /* next shortcut in list */
990 char *sh_short
; /* shortcut string */
991 char *sh_long
; /* expanded form */
994 /* Kludges to handle the change from setexit / reset to setjmp / longjmp */
995 #define setexit() (void)sigsetjmp(srbuf, 1)
996 #define reset(x) siglongjmp(srbuf, x)
998 /* Content-Transfer-Encodings as defined in RFC 2045:
999 * - Quoted-Printable, section 6.7
1000 * - Base64, section 6.8 */
1002 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
1004 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
1005 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
1007 /* xxx QP came later, maybe rewrite all to use mimecte_flags directly? */
1008 enum __mimecte_flags
{
1010 MIMECTE_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
1011 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
1013 MIMECTE_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
1014 MIMECTE_LF
= 1<<3, /* (encode) Append "\n" to lines */
1015 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
1016 * inject the desired line-ending whenever a linewrap is desired */
1017 MIMECTE_MULTILINE
= 1<<4,
1018 /* (encode) Quote with header rules, do not generate soft NL breaks? */
1019 MIMECTE_ISHEAD
= 1<<5
1023 QP_NONE
= MIMECTE_NONE
,
1024 QP_SALLOC
= MIMECTE_SALLOC
,
1025 QP_BUF
= MIMECTE_BUF
,
1026 QP_ISHEAD
= MIMECTE_ISHEAD
1030 B64_NONE
= MIMECTE_NONE
,
1031 B64_SALLOC
= MIMECTE_SALLOC
,
1032 B64_BUF
= MIMECTE_BUF
,
1033 B64_CRLF
= MIMECTE_CRLF
,
1034 B64_LF
= MIMECTE_LF
,
1035 B64_MULTILINE
= MIMECTE_MULTILINE
1038 /* Locale-independent character classes */
1051 #define __ischarof(C, FLAGS) \
1052 (asciichar(C) && (class_char[(uc_it)(C)] & (FLAGS)) != 0)
1054 #define asciichar(c) ((uc_it)(c) <= 0177)
1055 #define alnumchar(c) __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
1056 #define alphachar(c) __ischarof(c, C_UPPER | C_LOWER)
1057 #define blankchar(c) __ischarof(c, C_BLANK)
1058 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
1059 #define cntrlchar(c) __ischarof(c, C_CNTRL)
1060 #define digitchar(c) __ischarof(c, C_DIGIT | C_OCTAL)
1061 #define lowerchar(c) __ischarof(c, C_LOWER)
1062 #define punctchar(c) __ischarof(c, C_PUNCT)
1063 #define spacechar(c) __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
1064 #define upperchar(c) __ischarof(c, C_UPPER)
1065 #define whitechar(c) __ischarof(c, C_BLANK | C_WHITE)
1066 #define octalchar(c) __ischarof(c, C_OCTAL)
1068 #define upperconv(c) (lowerchar(c) ? (char)((uc_it)(c) - 'a' + 'A') : (c))
1069 #define lowerconv(c) (upperchar(c) ? (char)((uc_it)(c) - 'A' + 'a') : (c))
1071 #define fieldnamechar(c) \
1072 (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
1074 /* Try to use alloca() for some function-local buffers and data, fall back to
1075 * smalloc()/free() if not available */
1077 # define ac_alloc(n) HAVE_ALLOCA(n)
1078 # define ac_free(n) do {} while (0)
1080 # define ac_alloc(n) smalloc(n)
1081 # define ac_free(n) free(n)
1084 /* Single-threaded, use unlocked I/O */
1085 #ifdef HAVE_PUTC_UNLOCKED
1087 # define getc(c) getc_unlocked(c)
1089 # define putc(c, f) putc_unlocked(c, f)
1091 # define putchar(c) putc_unlocked((c), stdout)
1094 /* Truncate a file to the last character written. This is useful just before
1095 * closing an old file that was opened for read/write */
1096 #define ftrunc(stream) \
1100 off = ftell(stream);\
1102 ftruncate(fileno(stream), off);\
1105 /* fflush() and rewind() */
1106 #define fflush_rewind(stream) \
1112 /* For saving the current directory and later returning */
1117 char cw_wd
[MAXPATHLEN
];
1122 * Global variable declarations
1124 * These become instantiated in main.c.
1129 # ifndef HAVE_AMALGAMATION
1138 VL gid_t effectivegid
; /* Saved from when we started up */
1139 VL gid_t realgid
; /* Saved from when we started up */
1141 VL
int mb_cur_max
; /* Value of MB_CUR_MAX */
1142 VL
int realscreenheight
; /* The real screen height */
1143 VL
int scrnwidth
; /* Screen width, or best guess */
1144 VL
int scrnheight
; /* Screen height/guess (4 header) */
1145 VL
int utf8
; /* Locale uses UTF-8 encoding */
1146 VL
int enc_has_state
; /* Encoding has shift states */
1148 VL
char **altnames
; /* List of alternate names of user */
1149 VL
char const *homedir
; /* Path name of home directory */
1150 VL
char const *myname
; /* My login name */
1151 VL
char const *progname
; /* Our name */
1152 VL
char const *tempdir
; /* The temporary directory */
1154 VL
int exit_status
; /* Exit status */
1155 VL
int options
; /* Bits of enum user_options */
1156 VL
char *option_r_arg
; /* Argument to -r option */
1157 VL
char const **smopts
; /* sendmail(1) opts from commline */
1158 VL
size_t smopts_count
; /* Entries in smopts */
1160 /* TODO Join as many of these state machine bits into a single carrier! */
1161 VL
int inhook
; /* Currently executing a hook */
1162 VL bool_t exec_last_comm_error
; /* Last execute() command failed */
1163 VL bool_t edit
; /* Indicates editing a file */
1164 VL bool_t did_print_dot
; /* Current message has been printed */
1165 VL bool_t msglist_is_single
; /* Last NDMLIST/MSGLIST chose 1 msg */
1166 VL bool_t loading
; /* Loading user definitions */
1167 VL bool_t sourcing
; /* Currently reading variant file */
1168 VL bool_t sawcom
; /* Set after first command */
1169 VL bool_t starting
; /* Still in startup code */
1170 VL bool_t var_unset_allow_undefined
; /* var_unset(): don't complain */
1171 VL
int noreset
; /* String resets suspended */
1173 /* XXX stylish sorting */
1174 VL
int msgCount
; /* Count of messages read in */
1175 VL
enum condition cond
; /* State of conditional exc. */
1176 VL
struct mailbox mb
; /* Current mailbox */
1177 VL
int image
; /* File descriptor for msg image */
1178 VL
char mailname
[MAXPATHLEN
]; /* Name of current file */
1179 VL
char displayname
[80 - 40]; /* Prettyfied for display */
1180 VL
char prevfile
[MAXPATHLEN
]; /* Name of previous file */
1181 VL
char const *account_name
; /* Current account name or NULL */
1182 VL off_t mailsize
; /* Size of system mailbox */
1183 VL
struct message
*dot
; /* Pointer to current message */
1184 VL
struct message
*prevdot
; /* Previous current message */
1185 VL
struct message
*message
; /* The actual message structure */
1186 VL
struct message
*threadroot
; /* first threaded message */
1187 VL
int imap_created_mailbox
; /* hack to get feedback from imap */
1188 VL
int msgspace
; /* Number of allocated struct m */
1190 VL
struct grouphead
*groups
[HSHSIZE
]; /* Pointer to active groups */
1191 VL
struct ignoretab ignore
[2]; /* ignored and retained fields
1192 * 0 is ignore, 1 is retain */
1193 VL
struct ignoretab saveignore
[2]; /* ignored and retained fields
1194 * on save to folder */
1195 VL
struct ignoretab allignore
[2]; /* special, ignore all headers */
1196 VL
struct ignoretab fwdignore
[2]; /* fields to ignore for forwarding */
1197 VL
struct shortcut
*shortcuts
; /* list of shortcuts */
1199 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
1200 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
1203 VL
enum ssl_vrfy_level ssl_vrfy_level
; /* SSL verification level */
1214 VL sigjmp_buf srbuf
;
1216 VL sighandler_type dflpipe
;
1217 VL sighandler_type handlerstacktop
;
1218 #define handlerpush(f) (savedtop = handlerstacktop, handlerstacktop = (f))
1219 #define handlerpop() (handlerstacktop = savedtop)
1221 /* The remaining variables need initialization */
1223 #ifndef HAVE_AMALGAMATION
1224 VL
char const month_names
[12 + 1][4];
1225 VL
char const weekday_names
[7 + 1][4];
1227 VL
char const uagent
[]; /* User agent */
1228 VL
char const version
[]; /* The version string */
1229 VL
char const features
[]; /* The "feature string" */
1231 VL uc_it
const class_char
[];
1235 * Finally, let's include the function prototypes XXX embed
1240 /* vim:set fenc=utf-8:s-it-mode */