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 - 2015 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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Mail -- a mail program
39 * Author: Kurt Shoens (UCB) March 25, 1978
45 #include <sys/types.h>
47 #ifdef HAVE_GETTIMEOFDAY
48 # include <sys/time.h>
64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
67 # include <inttypes.h>
84 #ifdef HAVE_OPENSSL_MD5
85 # include <openssl/md5.h>
89 * Constants, some nail-specific macros
92 #if !defined NI_MAXHOST
93 # define NI_MAXHOST 1025
96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
99 # define PATH_MAX MAXPATHLEN
101 # define PATH_MAX 1024 /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
105 #ifndef HOST_NAME_MAX
106 # ifdef _POSIX_HOST_NAME_MAX
107 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
109 # define HOST_NAME_MAX 255
114 # ifdef _POSIX_NAME_MAX
115 # define NAME_MAX _POSIX_NAME_MAX
121 # error NAME_MAX too small
125 # define STDIN_FILENO 0
127 #ifndef STDOUT_FILENO
128 # define STDOUT_FILENO 1
130 #ifndef STDERR_FILENO
131 # define STDERR_FILENO 2
136 # define NSIG NSIG_MAX
138 # define NSIG ((sizeof(sigset_t) * 8) - 1)
142 # define _O_CLOEXEC O_CLOEXEC
143 # define _CLOEXEC_SET(FD) do {;} while(0)
145 # define _O_CLOEXEC 0
146 # define _CLOEXEC_SET(FD) \
147 do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
152 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
153 # define LINESIZE BUFSIZ /* max readable line width */
155 # define LINESIZE 2560
157 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
159 /* Network protocol newline */
160 #define NETNL "\015\012"
161 #define NETLINE(X) X NETNL
163 /* Number of Not-Yet-Dead calls that are remembered */
164 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
166 # define NYD_CALLS_MAX (25 * 84)
167 # elif defined HAVE_DEVEL
168 # define NYD_CALLS_MAX (25 * 42)
170 # define NYD_CALLS_MAX (25 * 10)
174 #define APPEND /* New mail goes to end of mailbox */
175 #define CBAD (-15555)
176 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
177 #define FILE_LOCK_TRIES 10 /* Maximum tries before file_lock() fails */
178 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
179 #define ESCAPE '~' /* Default escape for sending */
180 #define FIO_STACK_SIZE 20 /* Maximum recursion for sourcing */
181 #define HIST_SIZE 242 /* tty.c: history list default size */
182 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
183 #define MAXARGC 1024 /* Maximum list of raw strings */
184 #define MAXEXP 25 /* Maximum expansion of aliases */
185 #define PROMPT_BUFFER_SIZE 80 /* getprompt() bufsize (> 3!) */
186 #define REFERENCES_MAX 20 /* Maximum entries in References: */
187 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
189 #define ACCOUNT_NULL "null" /* Name of "null" account */
190 #define MAILRC "~/.mailrc"
191 #define NETRC "~/.netrc"
192 #define TMPDIR_FALLBACK "/tmp"
194 /* Some environment variables for pipe hooks */
195 #define AGENT_USER "NAIL_USER"
196 #define AGENT_USER_ENC "NAIL_USER_ENC"
197 #define AGENT_HOST "NAIL_HOST"
198 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
206 #define COLOUR_MSGINFO "fg=green"
207 #define COLOUR_PARTINFO "fg=brown"
208 #define COLOUR_FROM_ "fg=brown"
209 #define COLOUR_HEADER "fg=red"
210 #define COLOUR_UHEADER "ft=bold,fg=red"
211 #define COLOUR_TERMS \
212 "cons25,linux,rxvt,rxvt-unicode,screen,sun,vt100,vt220,wsvt25,xterm"
213 #define COLOUR_USER_HEADERS "from,subject"
215 #define FROM_DATEBUF 64 /* Size of RFC 4155 From_ line date */
216 #define DATE_DAYSYEAR 365L
217 #define DATE_SECSMIN 60L
218 #define DATE_MINSHOUR 60L
219 #define DATE_HOURSDAY 24L
220 #define DATE_SECSDAY (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
222 /* *indentprefix* default as of POSIX */
223 #define INDENT_DEFAULT "\t"
225 /* Default *encoding* as enum mime_enc below */
226 #define MIME_DEFAULT_ENCODING MIMEE_QP
228 /* Maximum allowed line length in a mail before QP folding is necessary), and
229 * the real limit we go for */
230 #define MIME_LINELEN_MAX 998 /* Plus CRLF */
231 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
234 #define MIME_LINELEN 78 /* Plus CRLF */
236 /* And in headers which contain an encoded word according to RFC 2047 there is
237 * yet another limit; also RFC 2045: 6.7, (5). */
238 #define MIME_LINELEN_RFC2047 76
240 /* Locations of mime.types(5) */
241 #define MIME_TYPES_USR "~/.mime.types"
242 #define MIME_TYPES_SYS "/etc/mime.types"
244 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set */
245 #define CHARSET_7BIT "US-ASCII"
247 # define CHARSET_8BIT "UTF-8"
248 # define CHARSET_8BIT_OKEY charset_8bit
250 # define CHARSET_8BIT "ISO-8859-1"
251 # define CHARSET_8BIT_OKEY ttycharset
254 /* Some environment variables for pipe hooks etc. */
255 #define NAILENV_TMPDIR "NAIL_TMPDIR"
256 #define NAILENV_FILENAME "NAIL_FILENAME"
257 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
258 #define NAILENV_CONTENT "NAIL_CONTENT"
259 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
261 /* Is *W* a quoting (ASCII only) character? */
263 ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
265 /* Maximum number of quote characters (not bytes!) that'll be used on
266 * follow lines when compressing leading quote characters */
269 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
270 #define QUOTE_TAB_SPACES 8
272 /* Maximum size of a message that is passed through to the spam system */
273 #define SPAM_MAXSIZE 420000
275 /* String dope: dynamic buffer size, and size of the single builtin one that's
276 * used first; note that these value include the size of the structure */
277 #define SBUFFER_SIZE ((0x10000u >> 1u) - 0x400)
278 #define SBUFFER_BUILTIN (0x10000u >> 1u)
280 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
282 # define XSHELL "/bin/sh"
285 # define XLISTER "ls"
288 # define XPAGER "more"
292 * OS, CC support, generic macros etc.
295 /* OS: we're not a library, only set what needs special treatment somewhere */
296 #define OS_DRAGONFLY 0
302 # define OS_DRAGONFLY 1
303 #elif defined __solaris__ || defined __sun
304 # if defined __SVR4 || defined __svr4__
306 # define OS_SOLARIS 1
315 #define PREREQ_CLANG(X,Y) 0
317 #define PREREQ_GCC(X,Y) 0
323 # define PREREQ_CLANG(X,Y) \
324 (__clang_major__ + 0 > (X) || \
325 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
326 # define __EXTEN __extension__
327 #elif defined __GNUC__
331 # define PREREQ_GCC(X,Y) \
332 (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
333 # define __EXTEN __extension__
340 /* Suppress some technical warnings via #pragma's unless developing.
341 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
343 # if PREREQ_CLANG(3, 4)
344 # pragma clang diagnostic ignored "-Wunused-result"
345 # pragma clang diagnostic ignored "-Wformat"
346 # elif PREREQ_GCC(4, 7)
347 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
348 # pragma GCC diagnostic ignored "-Wunused-result"
349 # pragma GCC diagnostic ignored "-Wformat"
353 /* For injection macros like DBG(), NATCH_CHAR() */
356 #define EMPTY_FILE() typedef int CONCAT(avoid_empty_file__, n_FILE);
358 /* Pointer to size_t */
359 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
361 /* Pointer comparison (types from below) */
362 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
364 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
365 * Note: doesn't sign-extend correctly, that's still up to the caller */
366 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
368 /* Align something to a size/boundary that cannot cause just any problem */
369 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
371 /* Members in constant array */
373 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
376 /* sizeof() for member fields */
377 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
379 /* Casts-away (*NOT* cast-away) */
380 #define UNUSED(X) ((void)(X))
381 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
382 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
383 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
385 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
386 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
387 # define STRING(X) #X
388 # define XSTRING(X) STRING(X)
389 # define CONCAT(S1,S2) _CONCAT(S1, S2)
390 # define _CONCAT(S1,S2) S1 ## S2
392 # define STRING(X) "X"
393 # define XSTRING STRING
394 # define CONCAT(S1,S2) S1/**/S2
397 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
398 /* Variable size arrays and structure fields */
399 # define VFIELD_SIZE(X)
400 # define VFIELD_SIZEOF(T,F) (0)
401 /* Inline functions */
403 # define INLINE inline
404 # define SINLINE static inline
406 # define VFIELD_SIZE(X) \
407 ((X) == 0 ? sizeof(size_t) \
408 : ((ssize_t)(X) < 0 ? sizeof(size_t) - (X) : (size_t)(X)))
409 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
410 # if CC_CLANG || PREREQ_GCC(2, 9)
411 # define INLINE static __inline
412 # define SINLINE static __inline
415 # define SINLINE static
420 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
421 # define __FUN__ __func__
422 #elif CC_CLANG || PREREQ_GCC(3, 4)
423 # define __FUN__ __extension__ __FUNCTION__
425 # define __FUN__ uagent /* Something that is not a literal */
428 #if defined __predict_true && defined __predict_false
429 # define LIKELY(X) __predict_true(X)
430 # define UNLIKELY(X) __predict_false(X)
431 #elif CC_CLANG || PREREQ_GCC(2, 96)
432 # define LIKELY(X) __builtin_expect(X, 1)
433 # define UNLIKELY(X) __builtin_expect(X, 0)
435 # define LIKELY(X) (X)
436 # define UNLIKELY(X) (X)
439 #undef HAVE_NATCH_CHAR
441 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
442 # define HAVE_NATCH_CHAR
443 # define NATCH_CHAR(X) X
445 # define NATCH_CHAR(X)
448 /* Compile-Time-Assert
449 * Problem is that some compilers warn on unused local typedefs, so add
450 * a special local CTA to overcome this */
451 #define CTA(TEST) _CTA_1(TEST, n_FILE, __LINE__)
452 #define LCTA(TEST) _LCTA_1(TEST, n_FILE, __LINE__)
454 #define _CTA_1(T,F,L) _CTA_2(T, F, L)
455 #define _CTA_2(T,F,L) \
456 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
457 #define _LCTA_1(T,F,L) _LCTA_2(T, F, L)
458 #define _LCTA_2(T,F,L) \
460 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
461 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
462 UNUSED(__i_am_unused__);\
465 #define UNINIT(N,V) N = V
468 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
470 #define MIN(A, B) ((A) < (B) ? (A) : (B))
472 #define MAX(A, B) ((A) < (B) ? (B) : (A))
474 #define ABS(A) ((A) < 0 ? -(A) : (A))
480 # define assert(X) UNUSED(0)
483 # define DBGOR(X,Y) Y
487 # define DBGOR(X,Y) X
490 /* Translation (init in main.c) */
503 # define UI8_MAX UINT8_MAX
504 # define SI8_MIN INT8_MIN
505 # define SI8_MAX INT8_MAX
506 typedef uint8_t ui8_t
;
507 typedef int8_t si8_t
;
508 #elif UCHAR_MAX != 255
509 # error UCHAR_MAX must be 255
511 # define UI8_MAX UCHAR_MAX
512 # define SI8_MIN CHAR_MIN
513 # define SI8_MAX CHAR_MAX
514 typedef unsigned char ui8_t
;
515 typedef signed char si8_t
;
518 #if !defined PRIu8 || !defined PRId8
526 # define UI16_MAX UINT16_MAX
527 # define SI16_MIN INT16_MIN
528 # define SI16_MAX INT16_MAX
529 typedef uint16_t ui16_t
;
530 typedef int16_t si16_t
;
531 #elif USHRT_MAX != 0xFFFFu
532 # error USHRT_MAX must be 0xFFFF
534 # define UI16_MAX USHRT_MAX
535 # define SI16_MIN SHRT_MIN
536 # define SI16_MAX SHRT_MAX
537 typedef unsigned short ui16_t
;
538 typedef signed short si16_t
;
541 #if !defined PRIu16 || !defined PRId16
544 # if UI16_MAX == UINT_MAX
554 # define UI32_MAX UINT32_MAX
555 # define SI32_MIN INT32_MIN
556 # define SI32_MAX INT32_MAX
557 typedef uint32_t ui32_t
;
558 typedef int32_t si32_t
;
559 #elif ULONG_MAX == 0xFFFFFFFFu
560 # define UI32_MAX ULONG_MAX
561 # define SI32_MIN LONG_MIN
562 # define SI32_MAX LONG_MAX
563 typedef unsigned long int ui32_t
;
564 typedef signed long int si32_t
;
565 #elif UINT_MAX != 0xFFFFFFFFu
566 # error UINT_MAX must be 0xFFFFFFFF
568 # define UI32_MAX UINT_MAX
569 # define SI32_MIN INT_MIN
570 # define SI32_MAX INT_MAX
571 typedef unsigned int ui32_t
;
572 typedef signed int si32_t
;
575 #if !defined PRIu32 || !defined PRId32
578 # if UI32_MAX == ULONG_MAX
588 # define UI64_MAX UINT64_MAX
589 # define SI64_MIN INT64_MIN
590 # define SI64_MAX INT64_MAX
591 typedef uint64_t ui64_t
;
592 typedef int64_t si64_t
;
593 #elif ULONG_MAX <= 0xFFFFFFFFu
594 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
595 # error We need a 64 bit integer
597 # define UI64_MAX ULLONG_MAX
598 # define SI64_MIN LLONG_MIN
599 # define SI64_MAX LLONG_MAX
600 __EXTEN
typedef unsigned long long ui64_t
;
601 __EXTEN
typedef signed long long si64_t
;
604 # define UI64_MAX ULONG_MAX
605 # define SI64_MIN LONG_MIN
606 # define SI64_MAX LONG_MAX
607 typedef unsigned long ui64_t
;
608 typedef signed long si64_t
;
611 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
615 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
616 # define PRIu64 "llu"
617 # define PRId64 "lld"
618 # define PRIX64 "llX"
626 /* (So that we can use UICMP() for size_t comparison, too) */
627 typedef size_t uiz_t
;
628 typedef ssize_t siz_t
;
632 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
635 # define PRIxZ_FMT_CTA() CTA(1 == 1)
636 # define UIZ_MAX SIZE_MAX
637 #elif defined SIZE_MAX
638 /* UnixWare has size_t as unsigned as required but uses a signed limit
639 * constant (which is thus false!) */
640 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
641 # define PRIuZ PRIu64
642 # define PRIdZ PRId64
643 # define PRIxZ_FMT_CTA() CTA(sizeof(size_t) == sizeof(ui64_t))
644 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
645 # define PRIuZ PRIu32
646 # define PRIdZ PRId32
647 # define PRIxZ_FMT_CTA() CTA(sizeof(size_t) == sizeof(ui32_t))
649 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
651 # define UIZ_MAX SIZE_MAX
656 # define PRIxZ_FMT_CTA() CTA(sizeof(size_t) == sizeof(unsigned long))
657 # define UIZ_MAX ULONG_MAX
662 # define uintptr_t size_t
663 # define UINTPTR_MAX SIZE_MAX
665 # define uintptr_t unsigned long
666 # define UINTPTR_MAX ULONG_MAX
670 #if !defined PRIuPTR || !defined PRIXPTR
673 # if UINTPTR_MAX == ULONG_MAX
674 # define PRIuPTR "lu"
675 # define PRIXPTR "lX"
682 enum {FAL0
, TRU1
, TRUM1
= -1};
683 typedef si8_t bool_t
;
685 /* Add shorter aliases for "normal" integers */
686 typedef unsigned long ul_i
;
687 typedef unsigned int ui_i
;
688 typedef unsigned short us_i
;
689 typedef unsigned char uc_i
;
691 typedef signed long sl_i
;
692 typedef signed int si_i
;
693 typedef signed short ss_i
;
694 typedef signed char sc_i
;
696 typedef void ( *sighandler_type
)(int);
699 AUTHTYPE_NONE
= 1<<0,
700 AUTHTYPE_PLAIN
= 1<<1, /* POP3: APOP is covered by this */
701 AUTHTYPE_LOGIN
= 1<<2,
702 AUTHTYPE_CRAM_MD5
= 1<<3,
703 AUTHTYPE_GSSAPI
= 1<<4
706 enum expand_addr_flags
{
707 EAF_NONE
= 0, /* -> EAF_NOFILE | EAF_NOPIPE */
708 EAF_RESTRICT
= 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
709 EAF_FAIL
= 1<<1, /* "fail" */
710 /* Bits reused by enum expand_addr_check_mode! */
711 EAF_FILE
= 1<<3, /* +"file" targets */
712 EAF_PIPE
= 1<<4, /* +"pipe" command pipe targets */
713 EAF_NAME
= 1<<5, /* +"name"s (non-address) names / MTA aliases */
714 EAF_ADDR
= 1<<6, /* +"addr" network address (contain "@") */
716 EAF_TARGET_MASK
= EAF_FILE
| EAF_PIPE
| EAF_NAME
| EAF_ADDR
,
717 EAF_RESTRICT_TARGETS
= EAF_NAME
| EAF_ADDR
/* (default set if not set) */
720 enum expand_addr_check_mode
{
721 EACM_NONE
= 0, /* Don't care about *expandaddr* */
722 EACM_NORMAL
= 1<<0, /* Use our normal *expandaddr* checking */
723 EACM_STRICT
= 1<<1, /* Never allow any file or pipe addresse */
724 EACM_MODE_MASK
= 0x3, /* _NORMAL and _STRICT are mutual! */
726 EACM_NOLOG
= 1<<2, /* Don't log check errors */
728 /* Some special overwrites of EAF_TARGETs.
729 * May NOT clash with EAF_* bits which may be ORd to these here! */
744 CONV_NONE
, /* no conversion */
745 CONV_7BIT
, /* no conversion, is 7bit */
746 CONV_FROMQP
, /* convert from quoted-printable */
747 CONV_TOQP
, /* convert to quoted-printable */
748 CONV_8BIT
, /* convert to 8bit (iconv) */
749 CONV_FROMB64
, /* convert from base64 */
750 CONV_FROMB64_T
, /* convert from base64/text */
751 CONV_TOB64
, /* convert to base64 */
752 CONV_FROMHDR
, /* convert from RFC1522 format */
753 CONV_TOHDR
, /* convert to RFC1522 format */
754 CONV_TOHDR_A
/* convert addresses for header */
765 DLS_CANT_CHDIR
, /* Failed to chdir(2) into desired path */
766 DLS_NAMETOOLONG
, /* Lock file name would be too long */
767 DLS_NOPERM
, /* No permission to creat lock file */
768 DLS_NOEXEC
, /* Privilege separated dotlocker not found */
769 DLS_PRIVFAILED
, /* Rising privileges failed in dotlocker */
770 DLS_EXIST
, /* Lock file already exists, stale lock? */
771 DLS_FISHY
, /* Something makes us think bad of situation */
772 DLS_DUNNO
, /* Catch-all error */
773 DLS_PING
, /* Not an error, but have to wait for lock */
774 DLS_ABANDON
= 1<<7 /* ORd to any but _NONE: give up, don't retry */
778 EXIT_OK
= EXIT_SUCCESS
,
779 EXIT_ERR
= EXIT_FAILURE
,
780 EXIT_USE
= 64, /* sysexits.h:EX_USAGE */
781 EXIT_NOUSER
= 67, /* :EX_NOUSER */
782 EXIT_COLL_ABORT
= 1<<1, /* Message collection was aborted */
783 EXIT_SEND_ERROR
= 1<<2 /* Unspecified send error occurred */
788 FEDIT_SYSBOX
= 1<<0, /* %: prefix */
789 FEDIT_RDONLY
= 1<<1, /* Readonly (per-box, OPT_R_FLAG is global) */
790 FEDIT_NEWMAIL
= 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
794 FEXP_FULL
, /* Full expansion */
795 FEXP_LOCAL
= 1<<0, /* Result must be local file/maildir */
796 FEXP_SHELL
= 1<<1, /* No folder %,#,&,+ stuff, yet sh(1) */
797 FEXP_NSHORTCUT
= 1<<2, /* Don't expand shortcuts */
798 FEXP_SILENT
= 1<<3, /* Don't print but only return errors */
799 FEXP_MULTIOK
= 1<<4, /* Expansion to many entries is ok */
800 FEXP_NSHELL
= 1<<5 /* Don't do shell word exp. (but ~/, $VAR) */
803 enum file_lock_type
{
809 MIME_UNKNOWN
, /* unknown content */
810 MIME_SUBHDR
, /* inside a multipart subheader */
811 MIME_822
, /* message/rfc822 content */
812 MIME_MESSAGE
, /* other message/ content */
813 MIME_TEXT_PLAIN
, /* text/plain content */
814 MIME_TEXT_HTML
, /* text/html content */
815 MIME_TEXT
, /* other text/ content */
816 MIME_ALTERNATIVE
, /* multipart/alternative content */
817 MIME_RELATED
, /* mime/related (RFC 2387) */
818 MIME_DIGEST
, /* multipart/digest content */
819 MIME_MULTI
, /* other multipart/ content */
820 MIME_PKCS7
, /* PKCS7 content */
821 MIME_DISCARD
/* content is discarded */
824 enum mime_counter_evidence
{
826 MIMECE_SET
= 1<<0, /* *mime-counter-evidence* was set */
827 MIMECE_BIN_OVWR
= 1<<1, /* appli../octet-stream: check, ovw if possible */
828 MIMECE_ALL_OVWR
= 1<<2, /* all: check, ovw if possible */
829 MIMECE_BIN_PARSE
= 1<<3 /* appli../octet-stream: classify contents last */
832 /* Content-Transfer-Encodings as defined in RFC 2045:
833 * - Quoted-Printable, section 6.7
834 * - Base64, section 6.8 */
835 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
837 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
838 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
841 MIMEE_NONE
, /* message is not in MIME format */
842 MIMEE_BIN
, /* message is in binary encoding */
843 MIMEE_8B
, /* message is in 8bit encoding */
844 MIMEE_7B
, /* message is in 7bit encoding */
845 MIMEE_QP
, /* message is quoted-printable */
846 MIMEE_B64
/* message is in base64 encoding */
849 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
850 enum mime_enc_flags
{
852 MIMEEF_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
853 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
855 MIMEEF_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
856 MIMEEF_LF
= 1<<3, /* (encode) Append "\n" to lines */
857 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
858 * inject the desired line-ending whenever a linewrap is desired */
859 MIMEEF_MULTILINE
= 1<<4,
860 /* (encode) Quote with header rules, do not generate soft NL breaks?
861 * For mustquote(), specifies wether special RFC 2047 header rules
862 * should be used instead */
863 MIMEEF_ISHEAD
= 1<<5,
864 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
865 * that characters which would not be reported as "must-quote" when
866 * detecting wether quoting is necessary at all will be reported as
867 * "must-quote" if they have to be encoded in an encoded word */
868 MIMEEF_ISENCWORD
= 1<<6,
869 __MIMEEF_LAST
= MIMEEF_ISENCWORD
873 QP_NONE
= MIMEEF_NONE
,
874 QP_SALLOC
= MIMEEF_SALLOC
,
876 QP_ISHEAD
= MIMEEF_ISHEAD
,
877 QP_ISENCWORD
= MIMEEF_ISENCWORD
881 B64_NONE
= MIMEEF_NONE
,
882 B64_SALLOC
= MIMEEF_SALLOC
,
883 B64_BUF
= MIMEEF_BUF
,
884 B64_CRLF
= MIMEEF_CRLF
,
886 B64_MULTILINE
= MIMEEF_MULTILINE
,
887 /* Not used, but for clarity only */
888 B64_ISHEAD
= MIMEEF_ISHEAD
,
889 B64_ISENCWORD
= MIMEEF_ISENCWORD
,
890 /* Special version of Base64, "Base64URL", according to RFC 4648.
891 * Only supported for encoding! */
892 B64_RFC4648URL
= __MIMEEF_LAST
<<1
895 /* Special handler return values for mime_type_mimepart_handler() */
896 #define MIME_TYPE_HANDLER_TEXT (char*)-1
897 #define MIME_TYPE_HANDLER_HTML (char*)-2
899 enum mime_parse_flags
{
901 MIME_PARSE_DECRYPT
= 1<<0,
902 MIME_PARSE_PARTS
= 1<<1
906 MLIST_OTHER
= 0, /* Normal address */
907 MLIST_KNOWN
= 1, /* A known `mlist' */
908 MLIST_SUBSCRIBED
= -1 /* A `mlsubscribe'd list */
919 OF_CLOEXEC
= 1<<7, /* TODO not used, always implied! CHANGE!! */
920 OF_UNLINK
= 1<<8, /* Only for Ftmp(): unlink(2) after creation */
921 OF_HOLDSIGS
= 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
922 OF_REGISTER
= 1<<10 /* Register file in our file table */
930 enum okey_xlook_mode
{
931 OXM_PLAIN
= 1<<0, /* Plain key always tested */
932 OXM_H_P
= 1<<1, /* Check PLAIN-.url_h_p */
933 OXM_U_H_P
= 1<<2, /* Check PLAIN-.url_u_h_p */
937 /* <0 means "stop" unless *prompt* extensions are enabled. */
939 PROMPT_STOP
= -1, /* \c */
940 /* *prompt* extensions: \$, \@ etc. */
946 PROTO_FILE
, /* refers to a local file */
947 PROTO_POP3
, /* is a pop3 server string */
948 PROTO_IMAP
, /* is an imap server string */
949 PROTO_MAILDIR
, /* refers to a maildir folder */
950 PROTO_UNKNOWN
/* unknown protocol */
954 SEND_MBOX
, /* no conversion to perform */
955 SEND_RFC822
, /* no conversion, no From_ line */
956 SEND_TODISP
, /* convert to displayable form */
957 SEND_TODISP_ALL
, /* same, include all MIME parts */
958 SEND_SHOW
, /* convert to 'show' command form */
959 SEND_TOSRCH
, /* convert for IMAP SEARCH */
960 SEND_TOFILE
, /* convert for saving body to a file */
961 SEND_TOPIPE
, /* convert for pipe-content/subc. */
962 SEND_QUOTE
, /* convert for quoting */
963 SEND_QUOTE_ALL
, /* same, include all MIME parts */
964 SEND_DECRYPT
/* decrypt */
968 enum ssl_verify_level
{
977 TD_NONE
, /* no display conversion */
978 TD_ISPR
= 1<<0, /* use isprint() checks */
979 TD_ICONV
= 1<<1, /* use iconv() */
980 TD_DELCTRL
= 1<<2, /* delete control characters */
983 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
984 * enum sendaction, and may thus NOT clash with their bit range!
986 _TD_EOF
= 1<<14, /* EOF seen, last round! */
987 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
992 OPT_DEBUG
= 1u<< 0, /* -d / *debug* */
993 OPT_VERB
= 1u<< 1, /* -v / *verbose* */
994 OPT_VERBVERB
= 1u<< 2, /* .. even more verbosity */
995 OPT_EXISTONLY
= 1u<< 3, /* -e */
996 OPT_HEADERSONLY
= 1u<<4, /* -H */
997 OPT_HEADERLIST
= 1u<< 5, /* -L */
998 OPT_QUICKRUN_MASK
= OPT_EXISTONLY
| OPT_HEADERSONLY
| OPT_HEADERLIST
,
999 OPT_NOSRC
= 1u<< 6, /* -n */
1000 OPT_E_FLAG
= 1u<< 7, /* -E / *skipemptybody* */
1001 OPT_F_FLAG
= 1u<< 8, /* -F */
1002 OPT_N_FLAG
= 1u<< 9, /* -N / *header* */
1003 OPT_R_FLAG
= 1u<<10, /* -R */
1004 OPT_r_FLAG
= 1u<<11, /* -r (plus option_r_arg) */
1005 OPT_t_FLAG
= 1u<<12, /* -t */
1006 OPT_u_FLAG
= 1u<<13, /* -u / $USER and pw->pw_uid != getuid(2) */
1007 OPT_TILDE_FLAG
= 1u<<14, /* -~ */
1008 OPT_BATCH_FLAG
= 1u<<15, /* -# */
1011 OPT_MEMDEBUG
= 1<<16, /* *memdebug* */
1014 OPT_SENDMODE
= 1u<<17, /* Usage case forces send mode */
1015 OPT_INTERACTIVE
= 1u<<18, /* isatty(0) */
1016 OPT_TTYIN
= OPT_INTERACTIVE
,
1017 OPT_TTYOUT
= 1u<<19,
1018 OPT_UNICODE
= 1u<<20, /* We're in an UTF-8 environment */
1019 OPT_ENC_MBSTATE
= 1u<<21, /* Multibyte environment with shift states */
1021 /* Some easy-access shortcuts */
1022 OPT_D_V
= OPT_DEBUG
| OPT_VERB
,
1023 OPT_D_VV
= OPT_DEBUG
| OPT_VERBVERB
1026 #define IS_TTY_SESSION() \
1027 ((options & (OPT_TTYIN | OPT_TTYOUT)) == (OPT_TTYIN | OPT_TTYOUT))
1029 #define OBSOLETE(X) \
1031 if (options & OPT_D_V)\
1032 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1034 #define OBSOLETE2(X,Y) \
1036 if (options & OPT_D_V)\
1037 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1040 enum program_state
{
1041 PS_STARTED
= 1<< 0, /* main.c startup code passed, functional */
1043 PS_LOADING
= 1<< 1, /* Loading user resource files, startup */
1044 PS_SOURCING
= 1<< 2, /* Sourcing a resource file */
1045 PS_IN_LOAD
= PS_LOADING
| PS_SOURCING
,
1047 PS_EVAL_ERROR
= 1<< 4, /* Last evaluate() command failed */
1049 PS_HOOK_NEWMAIL
= 1<< 6,
1051 PS_HOOK_MASK
= PS_HOOK_NEWMAIL
| PS_HOOK
,
1053 PS_EDIT
= 1<< 8, /* Current mailbox not a "system mailbox" */
1054 PS_SAW_COMMAND
= 1<< 9, /* ..after mailbox switch */
1056 PS_DID_PRINT_DOT
= 1<<16, /* Current message has been printed */
1058 PS_MSGLIST_SAW_NO
= 1<<17, /* Last *LIST saw numerics */
1059 PS_MSGLIST_DIRECT
= 1<<18, /* One msg was directly chosen by number */
1060 PS_MSGLIST_MASK
= PS_MSGLIST_SAW_NO
| PS_MSGLIST_DIRECT
,
1062 /* Various first-time-init switches */
1063 PS_ERRORS_NOTED
= 1<<24, /* Ring of `errors' content, print msg */
1064 PS_t_FLAG
= 1<<25 /* OPT_t_FLAG made persistant */
1067 /* A large enum with all the binary and value options a.k.a their keys.
1068 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1069 * ok_[bv]set() and ok_[bv]clear().
1070 * Note: see the comments in accmacvar.c before changing *anything* in here! */
1072 /* Option keys for binary options */
1073 ok_b_add_file_recipients
,
1083 ok_b_attachment_ask_content_description
,
1084 ok_b_attachment_ask_content_disposition
,
1085 ok_b_attachment_ask_content_id
,
1086 ok_b_attachment_ask_content_type
,
1091 ok_b_batch_exit_on_error
,
1099 ok_b_colour_disable
,
1101 ok_b_debug
, /* {special=1} */
1103 ok_b_disposition_notification_send
,
1105 ok_b_dotlock_ignore_error
,
1112 ok_b_forward_as_attachment
,
1114 ok_b_header
, /* {special=1} */
1116 ok_b_history_gabby_persist
,
1121 ok_b_imap_use_starttls
,
1123 ok_b_keep_content_length
,
1125 ok_b_line_editor_disable
,
1128 ok_b_message_id_disable
,
1130 ok_b_mime_allow_text_controls
,
1135 ok_b_pop3_bulk_load
,
1137 ok_b_pop3_use_starttls
,
1138 ok_b_print_all_chars
,
1139 ok_b_print_alternatives
,
1141 ok_b_quote_as_attachment
,
1142 ok_b_recipients_in_cc
,
1144 ok_b_reply_in_same_charset
,
1145 ok_b_rfc822_body_from_
, /* {name=rfc822-body-from_} */
1148 ok_b_sendcharsets_else_ttycharset
,
1153 ok_b_skipemptybody
, /* {special=1} */
1154 ok_b_smime_force_encryption
,
1155 ok_b_smime_no_default_ca
,
1157 ok_b_smtp_use_starttls
,
1158 ok_b_ssl_no_default_ca
,
1161 ok_b_verbose
, /* {special=1} */
1162 ok_b_writebackedited
,
1163 ok_b_memdebug
, /* {special=1} */
1165 /* Option keys for values options */
1166 ok_v_agent_shell_lookup
,
1173 ok_v_charset_unknown_8bit
,
1175 ok_v_colour_from_
, /* {name=colour-from_} */
1177 ok_v_colour_msginfo
,
1178 ok_v_colour_partinfo
,
1180 ok_v_colour_uheader
,
1181 ok_v_colour_user_headers
,
1184 ok_v_datefield_markout_older
,
1191 ok_v_features
, /* {rdonly=1,virtual=_features} */
1192 ok_v_folder
, /* {special=1} */
1194 ok_v_followup_to_honour
,
1202 ok_v_imap_keepalive
,
1203 ok_v_imap_list_depth
,
1205 ok_v_line_editor_cursor_right
, /* {special=1} */
1209 ok_v_mime_counter_evidence
,
1210 /* TODO v15-compat: mimetypes-load-control -> mimetypes-load / mimetypes */
1211 ok_v_mimetypes_load_control
,
1212 ok_v_NAIL_EXTRA_RC
, /* {name=NAIL_EXTRA_RC} */
1213 /* TODO v15-compat: NAIL_HEAD -> message-head? */
1214 ok_v_NAIL_HEAD
, /* {name=NAIL_HEAD} */
1215 /* TODO v15-compat: NAIL_HISTFILE -> history-file */
1216 ok_v_NAIL_HISTFILE
, /* {name=NAIL_HISTFILE} */
1217 /* TODO v15-compat: NAIL_HISTSIZE -> history-size{,limit} */
1218 ok_v_NAIL_HISTSIZE
, /* {name=NAIL_HISTSIZE} */
1219 /* TODO v15-compat: NAIL_TAIL -> message-tail? */
1220 ok_v_NAIL_TAIL
, /* {name=NAIL_TAIL} */
1226 /* TODO pop3_auth is yet a dummy to enable easier impl. of ccred_lookup()! */
1228 ok_v_pop3_keepalive
,
1235 ok_v_reply_to_honour
,
1240 ok_v_sendmail_arguments
,
1241 ok_v_sendmail_progname
,
1250 ok_v_smime_crl_file
,
1251 ok_v_smime_sign_cert
,
1252 ok_v_smime_sign_include_certs
,
1253 ok_v_smime_sign_message_digest
,
1255 /* TODO v15-compat: smtp-auth: drop */
1257 ok_v_smtp_auth_password
,
1258 ok_v_smtp_auth_user
,
1260 ok_v_spam_interface
,
1263 ok_v_spamc_arguments
,
1267 ok_v_spamfilter_ham
,
1268 ok_v_spamfilter_noham
,
1269 ok_v_spamfilter_nospam
,
1270 ok_v_spamfilter_rate
,
1271 ok_v_spamfilter_rate_scanscore
,
1272 ok_v_spamfilter_spam
,
1276 ok_v_ssl_cipher_list
,
1277 ok_v_ssl_config_file
,
1290 ok_v_version
, /* {rdonly=1,virtual=VERSION} */
1291 ok_v_version_major
, /* {rdonly=1,virtual=VERSION_MAJOR} */
1292 ok_v_version_minor
, /* {rdonly=1,virtual=VERSION_MINOR} */
1293 ok_v_version_update
, /* {rdonly=1,virtual=VERSION_UPDATE} */
1297 /* Locale-independent character classes */
1311 char *s
; /* the string's content */
1312 size_t l
; /* the stings's length */
1315 struct colour_table
{
1316 /* Plus a copy of *colour-user-headers* */
1317 struct str ct_csinfo
[COLOURSPEC_RESET
+1 + 1];
1321 struct str bi_start
; /* Start of (possibly) bidirectional text */
1322 struct str bi_end
; /* End of ... */
1323 size_t bi_pad
; /* No of visual columns to reserve for BIDI pad */
1327 char const *url_input
; /* Input as given (really) */
1328 enum cproto url_cproto
; /* Communication protocol as given */
1329 bool_t url_needs_tls
; /* Wether the protocol uses SSL/TLS */
1330 bool_t url_had_user
; /* Wether .url_user was part of the URL */
1331 ui16_t url_portno
; /* atoi .url_port or default, host endian */
1332 char const *url_port
; /* Port (if given) or NULL */
1333 char url_proto
[14]; /* Communication protocol as 'xy\0//' */
1334 ui8_t url_proto_len
; /* Length of .url_proto ('\0' index) */
1335 ui8_t url_proto_xlen
; /* .. if '\0' is replaced with ':' */
1336 struct str url_user
; /* User, exactly as given / looked up */
1337 struct str url_user_enc
; /* User, urlxenc()oded */
1338 struct str url_pass
; /* Pass (urlxdec()oded) or NULL */
1339 struct str url_host
; /* Service hostname */
1340 struct str url_path
; /* CPROTO_IMAP: path suffix or NULL */
1341 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1342 struct str url_h_p
; /* .url_host[:.url_port] */
1343 /* .url_user@.url_host
1344 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1345 * *hostname*)! (And may later be overwritten according to *from*!) */
1347 struct str url_u_h_p
; /* .url_user@.url_host[:.url_port] */
1348 struct str url_eu_h_p
; /* .url_user_enc@.url_host[:.url_port] */
1349 char const *url_p_u_h_p
; /* .url_proto://.url_u_h_p */
1350 char const *url_p_eu_h_p
; /* .url_proto://.url_eu_h_p */
1351 char const *url_p_eu_h_p_p
; /* .url_proto://.url_eu_h_p[/.url_path] */
1355 enum cproto cc_cproto
; /* Communication protocol */
1356 enum authtype cc_authtype
; /* Desired authentication */
1357 char const *cc_auth
; /* Authentication type as string */
1358 struct str cc_user
; /* User (urlxdec()oded) or NULL */
1359 struct str cc_pass
; /* Password (urlxdec()oded) or NULL */
1363 struct dotlock_info
{
1364 char const *di_file_name
;
1365 char const *di_lock_name
;
1366 char const *di_hostname
;
1367 char const *di_randstr
;
1368 size_t di_pollmsecs
;
1369 struct stat
*di_stb
;
1373 struct time_current
{
1381 FILE *qf_os
; /* Output stream */
1382 char const *qf_pfix
;
1383 ui32_t qf_pfix_len
; /* Length of prefix: 0: bypass */
1384 ui32_t qf_qfold_min
; /* Simple way: wrote prefix? */
1385 #ifdef HAVE_QUOTE_FOLD
1386 ui32_t qf_qfold_max
; /* Otherwise: line lengths */
1387 ui8_t qf_state
; /* *quote-fold* state machine */
1388 bool_t qf_brk_isws
; /* Breakpoint is at WS */
1390 ui32_t qf_wscnt
; /* Whitespace count */
1391 ui32_t qf_brkl
; /* Breakpoint */
1392 ui32_t qf_brkw
; /* Visual width, breakpoint */
1393 ui32_t qf_datw
; /* Current visual output line width */
1394 struct str qf_dat
; /* Current visual output line */
1395 struct str qf_currq
; /* Current quote, compressed */
1396 mbstate_t qf_mbps
[2];
1400 #ifdef HAVE_FILTER_HTML_TAGSOUP
1402 FILE *hf_os
; /* Output stream */
1404 ui32_t hf_lmax
; /* Maximum byte +1 in .hf_line/4 */
1405 ui32_t hf_len
; /* Current bytes in .hf_line */
1406 ui32_t hf_last_ws
; /* Last whitespace on line (fold purposes) */
1407 ui32_t hf_mboff
; /* Last offset for "mbtowc" */
1408 ui32_t hf_mbwidth
; /* We count characters not bytes if possible */
1409 char *hf_line
; /* Output line buffer - MUST be last field! */
1410 si32_t hf_href_dist
; /* Count of lines since last HREF flush */
1411 ui32_t hf_href_no
; /* HREF sequence number */
1412 struct htmlflt_href
*hf_hrefs
;
1413 struct htmlflt_tag
const *hf_ign_tag
; /* Tag that will end ignore mode */
1414 char *hf_curr
; /* Current cursor into .hf_bdat */
1415 char *hf_bmax
; /* Maximum byte in .hf_bdat +1 */
1416 char *hf_bdat
; /* (Temporary) Tag content data storage */
1420 struct search_expr
{
1421 char const *ss_where
; /* ..to search for the expr. (not always used) */
1422 char const *ss_sexpr
; /* String search expr.; NULL: use .ss_regex */
1429 struct str ev_line
; /* The terminated data to evaluate */
1430 ui32_t ev_line_size
; /* May be used to store line memory size */
1431 bool_t ev_is_recursive
; /* Evaluation in evaluation? (collect ~:) */
1433 bool_t ev_add_history
; /* Enter (final) command in history? */
1434 char const *ev_new_content
; /* History: reenter line, start with this */
1437 struct termios_state
{
1438 struct termios ts_tios
;
1441 bool_t ts_needs_reset
;
1444 #define termios_state_reset() \
1446 if (termios_state.ts_needs_reset) {\
1447 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1448 termios_state.ts_needs_reset = FAL0;\
1452 struct sock
{ /* data associated with a socket */
1453 int s_fd
; /* file descriptor */
1455 int s_use_ssl
; /* SSL is used */
1456 # ifdef HAVE_OPENSSL
1457 void *s_ssl
; /* SSL object */
1460 char *s_wbuf
; /* for buffered writes */
1461 int s_wbufsize
; /* allocated size of s_buf */
1462 int s_wbufpos
; /* position of first empty data byte */
1463 char *s_rbufptr
; /* read pointer to s_rbuf */
1464 int s_rsz
; /* size of last read in s_rbuf */
1465 char const *s_desc
; /* description of error messages */
1466 void (*s_onclose
)(void); /* execute on close */
1467 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
1472 struct ccred sc_cred
;
1473 struct sock sc_sock
;
1478 MB_NONE
= 000, /* no reply expected */
1479 MB_COMD
= 001, /* command reply expected */
1480 MB_MULT
= 002, /* multiline reply expected */
1481 MB_PREAUTH
= 004, /* not in authenticated state */
1482 MB_BYE
= 010 /* may accept a BYE state */
1484 FILE *mb_itf
; /* temp file with messages, read open */
1485 FILE *mb_otf
; /* same, write open */
1486 char *mb_sorted
; /* sort method */
1488 MB_VOID
, /* no type (e. g. connection failed) */
1489 MB_FILE
, /* local file */
1490 MB_POP3
, /* POP3 mailbox */
1491 MB_IMAP
, /* IMAP mailbox */
1492 MB_MAILDIR
, /* maildir folder */
1493 MB_CACHE
/* cached mailbox */
1494 } mb_type
; /* type of mailbox */
1496 MB_DELE
= 01, /* may delete messages in mailbox */
1497 MB_EDIT
= 02 /* may edit messages in mailbox */
1499 int mb_threaded
; /* mailbox has been threaded */
1503 MB_UIDPLUS
= 001 /* supports IMAP UIDPLUS */
1505 unsigned long mb_uidvalidity
; /* IMAP unique identifier validity */
1506 char *mb_imap_account
; /* name of current IMAP account */
1507 char *mb_imap_pass
; /* xxx v15-compat URL workaround */
1508 char *mb_imap_mailbox
; /* name of current IMAP mailbox */
1509 char *mb_cache_directory
; /* name of cache directory */
1511 struct sock mb_sock
; /* socket structure */
1515 NEED_UNSPEC
, /* unspecified need, don't fetch */
1516 NEED_HEADER
, /* need the header of a message */
1517 NEED_BODY
/* need header and body of a message */
1521 HAVE_NOTHING
, /* nothing downloaded yet */
1522 HAVE_HEADER
= 01, /* header is downloaded */
1523 HAVE_BODY
= 02 /* entire message is downloaded */
1526 /* flag bits. Attention: Flags that are used in cache.c may not change */
1528 MUSED
= (1<< 0), /* entry is used, but this bit isn't */
1529 MDELETED
= (1<< 1), /* entry has been deleted */
1530 MSAVED
= (1<< 2), /* entry has been saved */
1531 MTOUCH
= (1<< 3), /* entry has been noticed */
1532 MPRESERVE
= (1<< 4), /* keep entry in sys mailbox */
1533 MMARK
= (1<< 5), /* message is marked! */
1534 MODIFY
= (1<< 6), /* message has been modified */
1535 MNEW
= (1<< 7), /* message has never been seen */
1536 MREAD
= (1<< 8), /* message has been read sometime. */
1537 MSTATUS
= (1<< 9), /* message status has changed */
1538 MBOX
= (1<<10), /* Send this to mbox, regardless */
1539 MNOFROM
= (1<<11), /* no From line */
1540 MHIDDEN
= (1<<12), /* message is hidden to user */
1541 MFULLYCACHED
= (1<<13), /* message is completely cached */
1542 MBOXED
= (1<<14), /* message has been sent to mbox */
1543 MUNLINKED
= (1<<15), /* message was unlinked from cache */
1544 MNEWEST
= (1<<16), /* message is very new (newmail) */
1545 MFLAG
= (1<<17), /* message has been flagged recently */
1546 MUNFLAG
= (1<<18), /* message has been unflagged */
1547 MFLAGGED
= (1<<19), /* message is `flagged' */
1548 MANSWER
= (1<<20), /* message has been answered recently */
1549 MUNANSWER
= (1<<21), /* message has been unanswered */
1550 MANSWERED
= (1<<22), /* message is `answered' */
1551 MDRAFT
= (1<<23), /* message has been drafted recently */
1552 MUNDRAFT
= (1<<24), /* message has been undrafted */
1553 MDRAFTED
= (1<<25), /* message is marked as `draft' */
1554 MOLDMARK
= (1<<26), /* messages was marked previously */
1555 MSPAM
= (1<<27), /* message is classified as spam */
1556 MSPAMUNSURE
= (1<<28) /* message may be spam, but it is unsure */
1558 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
1559 #define MMNDEL (MDELETED | MHIDDEN)
1561 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
1564 enum mflag m_flag
; /* flags */
1565 enum havespec m_have
; /* downloaded parts of the part */
1567 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
1569 int m_block
; /* block number of this part */
1570 size_t m_offset
; /* offset in block of part */
1571 size_t m_size
; /* Bytes in the part */
1572 size_t m_xsize
; /* Bytes in the full part */
1573 long m_lines
; /* Lines in the message */
1574 long m_xlines
; /* Lines in the full message */
1575 time_t m_time
; /* time the message was sent */
1576 char const *m_from
; /* message sender */
1577 struct mimepart
*m_nextpart
; /* next part at same level */
1578 struct mimepart
*m_multipart
; /* parts of multipart */
1579 struct mimepart
*m_parent
; /* enclosing multipart part */
1580 char const *m_ct_type
; /* content-type */
1581 char const *m_ct_type_plain
; /* content-type without specs */
1582 char const *m_ct_type_usr_ovwr
; /* Forcefully overwritten one */
1583 enum mimecontent m_mimecontent
; /* same in enum */
1584 char const *m_charset
; /* charset */
1585 char const *m_ct_enc
; /* content-transfer-encoding */
1586 enum mime_enc m_mime_enc
; /* same in enum */
1587 char *m_partstring
; /* part level string */
1588 char *m_filename
; /* attachment filename */
1592 enum mflag m_flag
; /* flags */
1593 enum havespec m_have
; /* downloaded parts of the message */
1595 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
1597 int m_block
; /* block number of this message */
1598 size_t m_offset
; /* offset in block of message */
1599 size_t m_size
; /* Bytes in the message */
1600 size_t m_xsize
; /* Bytes in the full message */
1601 long m_lines
; /* Lines in the message */
1602 long m_xlines
; /* Lines in the full message */
1603 time_t m_time
; /* time the message was sent */
1604 time_t m_date
; /* time in the 'Date' field */
1605 unsigned m_idhash
; /* hash on Message-ID for threads */
1606 struct message
*m_child
; /* first child of this message */
1607 struct message
*m_younger
; /* younger brother of this message */
1608 struct message
*m_elder
; /* elder brother of this message */
1609 struct message
*m_parent
; /* parent of this message */
1610 unsigned m_level
; /* thread level of message */
1611 long m_threadpos
; /* position in threaded display */
1613 unsigned long m_uid
; /* IMAP unique identifier */
1615 char *m_maildir_file
; /* original maildir file of msg */
1616 ui32_t m_maildir_hash
; /* hash of file name in maildir sub */
1617 int m_collapsed
; /* collapsed thread information */
1620 /* Given a file address, determine the block number it represents */
1621 #define mailx_blockof(off) ((int) ((off) / 4096))
1622 #define mailx_offsetof(off) ((int) ((off) % 4096))
1623 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
1625 /* Argument types */
1627 ARG_MSGLIST
= 0, /* Message list type */
1628 ARG_STRLIST
= 1, /* A pure string */
1629 ARG_RAWLIST
= 2, /* Shell string list */
1630 ARG_NOLIST
= 3, /* Just plain 0 */
1631 ARG_NDMLIST
= 4, /* Message list, no defaults */
1632 ARG_ECHOLIST
= 5, /* Like raw list, but keep quote chars */
1633 ARG_ARGMASK
= 7, /* Mask of the above */
1635 ARG_A
= 1u<< 4, /* Needs an active mailbox */
1636 ARG_F
= 1u<< 5, /* Is a conditional command */
1637 ARG_H
= 1u<< 6, /* Never place in history */
1638 ARG_I
= 1u<< 7, /* Interactive command bit */
1639 ARG_M
= 1u<< 8, /* Legal from send mode bit */
1640 ARG_P
= 1u<< 9, /* Autoprint dot after command */
1641 ARG_R
= 1u<<10, /* Cannot be called from collect / recursion */
1642 ARG_T
= 1u<<11, /* Is a transparent command */
1643 ARG_V
= 1u<<12, /* Places data in temporary_arg_v_store */
1644 ARG_W
= 1u<<13, /* Invalid when read only bit */
1645 ARG_O
= 1u<<14 /* OBSOLETE()d command */
1649 GTO
= 1<< 0, /* Grab To: line */
1650 GSUBJECT
= 1<< 1, /* Likewise, Subject: line */
1651 GCC
= 1<< 2, /* And the Cc: line */
1652 GBCC
= 1<< 3, /* And also the Bcc: line */
1654 GNL
= 1<< 4, /* Print blank line after */
1655 GDEL
= 1<< 5, /* Entity removed from list */
1656 GCOMMA
= 1<< 6, /* detract puts in commas */
1657 GUA
= 1<< 7, /* User-Agent field */
1658 GMIME
= 1<< 8, /* MIME 1.0 fields */
1659 GMSGID
= 1<< 9, /* a Message-ID */
1661 GIDENT
= 1<<11, /* From:, Reply-To:, Organization:, MFT: */
1662 GREF
= 1<<12, /* References:, In-Reply-To:, (Message-Id:) */
1663 GDATE
= 1<<13, /* Date: field */
1664 GFULL
= 1<<14, /* Include full names, comments etc. */
1665 GSKIN
= 1<<15, /* Skin names */
1666 GEXTRA
= 1<<16, /* Extra fields (mostly like GIDENT XXX) */
1667 GFILES
= 1<<17, /* Include filename and pipe addresses */
1668 GFULLEXTRA
= 1<<18 /* Only with GFULL: GFULL less address */
1670 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
1674 HF_LIST_REPLY
= 1<< 0,
1675 HF_MFT_SENDER
= 1<< 1, /* Add ourselves to Mail-Followup-To: */
1676 HF_RECIPIENT_RECORD
= 1<<10, /* Save message in file named after rec. */
1680 /* Structure used to pass about the current state of a message (header) */
1682 ui32_t h_flags
; /* enum header_flags bits */
1684 struct name
*h_to
; /* Dynamic "To:" string */
1685 char *h_subject
; /* Subject string */
1686 struct name
*h_cc
; /* Carbon copies string */
1687 struct name
*h_bcc
; /* Blind carbon copies */
1688 struct name
*h_ref
; /* References (possibly overridden) */
1689 struct attachment
*h_attach
; /* MIME attachments */
1690 char *h_charset
; /* preferred charset */
1691 struct name
*h_from
; /* overridden "From:" field */
1692 struct name
*h_sender
; /* overridden "Sender:" field */
1693 struct name
*h_replyto
; /* overridden "Reply-To:" field */
1694 struct name
*h_message_id
; /* overridden "Message-ID:" field */
1695 struct name
*h_in_reply_to
;/* overridden "In-Reply-To:" field */
1696 struct name
*h_mft
; /* Mail-Followup-To */
1697 char const *h_list_post
; /* Address from List-Post:, for `Lreply' */
1698 char *h_organization
; /* overridden "Organization:" field */
1701 /* Handling of namelist nodes used in processing the recipients of mail and
1702 * aliases, inspection of mail-addresses and all that kind of stuff */
1704 NAME_NAME_SALLOC
= 1<< 0, /* .n_name is doped */
1705 NAME_FULLNAME_SALLOC
= 1<< 1, /* .n_fullname is doped */
1706 NAME_SKINNED
= 1<< 2, /* Is actually skin()ned */
1707 NAME_IDNA
= 1<< 3, /* IDNA was applied */
1709 NAME_ADDRSPEC_CHECKED
= 1<< 4, /* Address has been .. and */
1710 NAME_ADDRSPEC_ISFILE
= 1<< 5, /* ..is a file path */
1711 NAME_ADDRSPEC_ISPIPE
= 1<< 6, /* ..is a command for piping */
1712 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
1713 NAME_ADDRSPEC_ISNAME
= 1<< 7, /* ..is a valid mail network address */
1714 NAME_ADDRSPEC_ISADDR
= 1<< 8, /* ..is a valid mail network address */
1716 NAME_ADDRSPEC_ERR_EMPTY
= 1<< 9, /* An empty string (or NULL) */
1717 NAME_ADDRSPEC_ERR_ATSEQ
= 1<<10, /* Weird @ sequence */
1718 NAME_ADDRSPEC_ERR_CHAR
= 1<<11, /* Invalid character */
1719 NAME_ADDRSPEC_ERR_IDNA
= 1<<12, /* IDNA convertion failed */
1720 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
1721 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
1722 NAME_ADDRSPEC_ERR_IDNA
,
1724 /* Error storage (we must fit in 31-bit) */
1726 _NAME_MAXWC
= 0x3FFFF,
1727 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
1730 /* In the !_ERR_EMPTY case, the failing character can be queried */
1731 #define NAME_ADDRSPEC_ERR_GETWC(F) \
1732 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1733 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1735 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1736 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1740 struct name
*n_flink
; /* Forward link in list. */
1741 struct name
*n_blink
; /* Backward list link */
1742 enum gfield n_type
; /* From which list it came */
1743 enum nameflags n_flags
; /* enum nameflags */
1744 char *n_name
; /* This fella's address */
1745 char *n_fullname
; /* Ditto, unless GFULL including comment */
1746 char *n_fullextra
; /* GFULL, without address */
1750 char const *ag_input
; /* Input string as given */
1751 size_t ag_ilen
; /* strlen() of input */
1752 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
1753 size_t ag_iaddr_aend
; /* ..and one past its end */
1754 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
1755 size_t ag_slen
; /* strlen() of .ag_skinned */
1756 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
1757 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
1760 /* MIME attachments */
1762 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
1763 AC_FIX_OUTCS
, /* _get_lc() -> "charset=" .a_charset */
1764 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
1765 AC_TMPFILE
/* attachment.a_tmpf is converted */
1769 struct attachment
*a_flink
; /* Forward link in list. */
1770 struct attachment
*a_blink
; /* Backward list link */
1771 char const *a_name
; /* file name */
1772 char const *a_content_type
; /* content type */
1773 char const *a_content_disposition
; /* content disposition */
1774 char const *a_content_id
; /* content id */
1775 char const *a_content_description
; /* content description */
1776 char const *a_input_charset
; /* Interpretation depends on .a_conv */
1777 char const *a_charset
; /* ... */
1778 FILE *a_tmpf
; /* If AC_TMPFILE */
1779 enum attach_conv a_conv
; /* User chosen conversion */
1780 int a_msgno
; /* message number */
1784 struct header
*sb_hp
;
1787 struct str sb_signer
; /* USER@HOST for signing+ */
1789 struct ccred sb_ccred
;
1792 /* Structure of the hash table of ignored header fields */
1794 int i_count
; /* Number of entries */
1796 struct ignored
*i_link
; /* Next ignored field in bucket */
1797 char *i_field
; /* This ignored field */
1801 /* For saving the current directory and later returning */
1806 char cw_wd
[PATH_MAX
];
1811 * Global variable declarations
1813 * These become instantiated in main.c.
1817 #ifdef n_MAIN_SOURCE
1818 # ifndef HAVE_AMALGAMATION
1827 VL
int mb_cur_max
; /* Value of MB_CUR_MAX */
1828 VL
int realscreenheight
; /* The real screen height */
1829 VL
int scrnwidth
; /* Screen width, or best guess */
1830 VL
int scrnheight
; /* Screen height/guess (4 header) */
1832 VL
char const *homedir
; /* Path name of home directory */
1833 VL
char const *myname
; /* My login name */
1834 VL
char const *progname
; /* Our name */
1835 VL
char const *tempdir
; /* The temporary directory */
1837 VL ui32_t group_id
; /* getgid() and getuid() */
1840 VL
int exit_status
; /* Exit status */
1841 VL ui32_t options
; /* Bits of enum user_options */
1842 VL
struct name
*option_r_arg
; /* Argument to -r option */
1843 VL
char const **smopts
; /* sendmail(1) opts from commline */
1844 VL
size_t smopts_count
; /* Entries in smopts */
1846 VL ui32_t pstate
; /* Bits of enum program_state */
1847 VL
size_t noreset
; /* String resets suspended (recursive) */
1849 /* XXX stylish sorting */
1850 VL
int msgCount
; /* Count of messages read in */
1851 VL
struct mailbox mb
; /* Current mailbox */
1852 VL
int image
; /* File descriptor for msg image */
1853 VL
char mailname
[PATH_MAX
]; /* Name of current file TODO URL/object*/
1854 VL
char displayname
[80 - 40]; /* Prettyfied for display TODO URL/obj*/
1855 VL
char prevfile
[PATH_MAX
]; /* Name of previous file TODO URL/obj */
1856 VL
char const *account_name
; /* Current account name or NULL */
1857 VL off_t mailsize
; /* Size of system mailbox */
1858 VL
struct message
*dot
; /* Pointer to current message */
1859 VL
struct message
*prevdot
; /* Previous current message */
1860 VL
struct message
*message
; /* The actual message structure */
1861 VL
struct message
*threadroot
; /* first threaded message */
1862 VL
int imap_created_mailbox
; /* hack to get feedback from imap */
1864 VL
struct ignoretab ignore
[2]; /* ignored and retained fields
1865 * 0 is ignore, 1 is retain */
1866 VL
struct ignoretab saveignore
[2]; /* ignored and retained fields
1867 * on save to folder */
1868 VL
struct ignoretab allignore
[2]; /* special, ignore all headers */
1869 VL
struct ignoretab fwdignore
[2]; /* fields to ignore for forwarding */
1871 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
1872 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
1875 VL
struct colour_table
*colour_table
;
1879 VL
enum ssl_verify_level ssl_verify_level
; /* SSL verification level */
1886 VL sigjmp_buf srbuf
;
1888 VL sighandler_type dflpipe
;
1889 VL sighandler_type handlerstacktop
;
1890 #define handlerpush(f) (savedtop = handlerstacktop, handlerstacktop = (f))
1891 #define handlerpop() (handlerstacktop = savedtop)
1893 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
1894 * TODO carrier structs instead of locals */
1895 VL
char *temporary_arg_v_store
;
1896 VL
void *temporary_localopts_store
;
1897 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
1898 VL
char const *temporary_protocol_ext
;
1900 /* The remaining variables need initialization */
1902 #ifndef HAVE_AMALGAMATION
1903 VL
char const month_names
[12 + 1][4];
1904 VL
char const weekday_names
[7 + 1][4];
1906 VL
char const uagent
[]; /* User agent */
1908 VL uc_i
const class_char
[];
1912 * Finally, let's include the function prototypes XXX embed
1915 #ifndef n_PRIVSEP_SOURCE
1916 # include "nailfuns.h"