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)
151 # define n_O_NOFOLLOW O_NOFOLLOW
153 # define n_O_NOFOLLOW 0
158 #if BUFSIZ + 0 > 2560 /* TODO simply use BUFSIZ? */
159 # define LINESIZE BUFSIZ /* max readable line width */
161 # define LINESIZE 2560
163 #define BUFFER_SIZE (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
165 /* Network protocol newline */
166 #define NETNL "\015\012"
167 #define NETLINE(X) X NETNL
169 /* Number of Not-Yet-Dead calls that are remembered */
170 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
172 # define NYD_CALLS_MAX (25 * 84)
173 # elif defined HAVE_DEVEL
174 # define NYD_CALLS_MAX (25 * 42)
176 # define NYD_CALLS_MAX (25 * 10)
180 #define APPEND /* New mail goes to end of mailbox */
181 #define CBAD (-15555)
182 #define DOTLOCK_TRIES 5 /* Number of open(2) calls for dotlock */
183 #define FILE_LOCK_TRIES 10 /* Maximum tries before n_file_lock() fails */
184 #define FILE_LOCK_MILLIS 200 /* If UIZ_MAX, fall back to that */
185 #define ERRORS_MAX 1000 /* Maximum error ring entries TODO configable*/
186 #define ESCAPE '~' /* Default escape for sending */
187 #define HIST_SIZE 242 /* tty.c: history list default size */
188 #define HSHSIZE 23 /* Hash prime TODO make dynamic, obsolete */
189 #define MAXARGC 1024 /* Maximum list of raw strings */
190 #define MAXEXP 25 /* Maximum expansion of aliases */
191 #define PROMPT_BUFFER_SIZE 80 /* getprompt() bufsize (> 3!) */
192 #define REFERENCES_MAX 20 /* Maximum entries in References: */
193 #define FTMP_OPEN_TRIES 10 /* Maximum number of Ftmp() open(2) tries */
195 #define ACCOUNT_NULL "null" /* Name of "null" account */
197 /* Some environment variables for pipe hooks */
198 #define AGENT_USER "NAIL_USER"
199 #define AGENT_USER_ENC "NAIL_USER_ENC"
200 #define AGENT_HOST "NAIL_HOST"
201 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
205 # define n_COLOUR(X) X
210 /* Special FD requests for run_command() / start_command() */
211 #define COMMAND_FD_PASS -1
212 #define COMMAND_FD_NULL -2
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 * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
246 #define CHARSET_7BIT "US-ASCII"
248 # define CHARSET_8BIT "UTF-8"
249 # define CHARSET_8BIT_OKEY charset_8bit
251 # define CHARSET_8BIT "ISO-8859-1"
252 # define CHARSET_8BIT_OKEY ttycharset
255 /* Some environment variables for pipe hooks etc. */
256 #define NAILENV_TMPDIR "NAIL_TMPDIR"
257 #define NAILENV_FILENAME "NAIL_FILENAME"
258 #define NAILENV_FILENAME_GENERATED "NAIL_FILENAME_GENERATED"
259 #define NAILENV_FILENAME_TEMPORARY "NAIL_FILENAME_TEMPORARY"
260 #define NAILENV_CONTENT "NAIL_CONTENT"
261 #define NAILENV_CONTENT_EVIDENCE "NAIL_CONTENT_EVIDENCE"
263 /* Is *W* a quoting (ASCII only) character? */
265 ((W) == n_WC_C('>') || (W) == n_WC_C('|') ||\
266 (W) == n_WC_C('}') || (W) == n_WC_C(':'))
268 /* Maximum number of quote characters (not bytes!) that'll be used on
269 * follow lines when compressing leading quote characters */
272 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
273 #define QUOTE_TAB_SPACES 8
275 /* Maximum size of a message that is passed through to the spam system */
276 #define SPAM_MAXSIZE 420000
278 /* String dope: dynamic buffer size, and size of the single builtin one that's
279 * used first; note that these value include the size of the structure */
280 #define SBUFFER_SIZE ((0x10000u >> 1u) - 0x400)
281 #define SBUFFER_BUILTIN (0x10000u >> 1u)
283 /* Switch indicating necessity of terminal access interface (termcap.c) */
284 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
289 * OS, CC support, generic macros etc.
292 /* OS: we're not a library, only set what needs special treatment somewhere */
293 #define OS_DRAGONFLY 0
299 # define OS_DRAGONFLY 1
300 #elif defined __solaris__ || defined __sun
301 # if defined __SVR4 || defined __svr4__
303 # define OS_SOLARIS 1
312 #define PREREQ_CLANG(X,Y) 0
314 #define PREREQ_GCC(X,Y) 0
316 #define PREREQ_TCC(X,Y) 0
322 # define PREREQ_CLANG(X,Y) \
323 (__clang_major__ + 0 > (X) || \
324 (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
325 # 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__
335 #elif defined __TINYC__
344 /* Suppress some technical warnings via #pragma's unless developing.
345 * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
347 # if PREREQ_CLANG(3, 4)
348 # pragma clang diagnostic ignored "-Wunused-result"
349 # pragma clang diagnostic ignored "-Wformat"
350 # elif PREREQ_GCC(4, 7)
351 # pragma GCC diagnostic ignored "-Wunused-local-typedefs"
352 # pragma GCC diagnostic ignored "-Wunused-result"
353 # pragma GCC diagnostic ignored "-Wformat"
357 /* For injection macros like DBG(), NATCH_CHAR() */
360 #define EMPTY_FILE() typedef int CONCAT(avoid_empty_file__, n_FILE);
362 /* Pointer to size_t */
363 #define PTR2SIZE(X) ((size_t)(uintptr_t)(X))
365 /* Pointer comparison (types from below) */
366 #define PTRCMP(A,C,B) ((uintptr_t)(A) C (uintptr_t)(B))
368 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
369 * Note: doesn't sign-extend correctly, that's still up to the caller */
370 #define UICMP(T,A,C,B) ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
372 /* Align something to a size/boundary that cannot cause just any problem */
373 #define n_ALIGN(X) (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
375 /* Members in constant array */
377 # define NELEM(A) (sizeof(A) / sizeof(A[0]))
380 /* sizeof() for member fields */
381 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
383 /* Casts-away (*NOT* cast-away) */
384 #define UNUSED(X) ((void)(X))
385 #define UNCONST(P) ((void*)(uintptr_t)(void const*)(P))
386 #define UNVOLATILE(P) ((void*)(uintptr_t)(void volatile*)(P))
387 #define UNXXX(T,C,P) ((T)(uintptr_t)(C)(P))
389 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
390 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
391 # define STRING(X) #X
392 # define XSTRING(X) STRING(X)
393 # define CONCAT(S1,S2) _CONCAT(S1, S2)
394 # define _CONCAT(S1,S2) S1 ## S2
396 # define STRING(X) "X"
397 # define XSTRING STRING
398 # define CONCAT(S1,S2) S1/**/S2
401 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
402 # define n_FIELD_INITN(N) CONCAT(., N) =
403 # define n_FIELD_INITI(I) [I] =
405 # define n_FIELD_INITN(N)
406 # define n_FIELD_INITI(N)
409 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
410 # define VFIELD_SIZE(X)
411 # define VFIELD_SIZEOF(T,F) (0)
412 # define VSTRUCT_SIZEOF(T,F) sizeof(T)
414 # define VFIELD_SIZE(X) \
415 ((X) == 0 ? sizeof(size_t) \
416 : ((ssize_t)(X) < 0 ? sizeof(size_t) - ABS(X) : (size_t)(X)))
417 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
418 # define VSTRUCT_SIZEOF(T,F) (sizeof(T) - SIZEOF_FIELD(T, F))
422 # define SINLINE n_INLINE /* TODO obsolete */
424 # define SINLINE static
428 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
429 # define __FUN__ __func__
430 #elif CC_CLANG || PREREQ_GCC(3, 4)
431 # define __FUN__ __extension__ __FUNCTION__
433 # define __FUN__ uagent /* Something that is not a literal */
436 #if defined __predict_true && defined __predict_false
437 # define LIKELY(X) __predict_true(X)
438 # define UNLIKELY(X) __predict_false(X)
439 #elif CC_CLANG || PREREQ_GCC(2, 96)
440 # define LIKELY(X) __builtin_expect(X, 1)
441 # define UNLIKELY(X) __builtin_expect(X, 0)
443 # define LIKELY(X) (X)
444 # define UNLIKELY(X) (X)
447 #undef HAVE_NATCH_CHAR
449 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
450 # define HAVE_NATCH_CHAR
451 # define NATCH_CHAR(X) X
453 # define NATCH_CHAR(X)
456 /* Compile-Time-Assert
457 * Problem is that some compilers warn on unused local typedefs, so add
458 * a special local CTA to overcome this */
459 #define CTA(TEST) _CTA_1(TEST, n_FILE, __LINE__)
460 #define LCTA(TEST) _LCTA_1(TEST, n_FILE, __LINE__)
462 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
463 # define n_CTA(T,M) _Static_assert(T, M)
464 # define n_LCTA(T,M) _Static_assert(T, M)
466 # define n_CTA(T,M) _CTA_1(T, n_FILE, __LINE__)
467 # define n_LCTA(T,M) _LCTA_1(T, n_FILE, __LINE__)
469 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
470 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
473 # define n_MCTA(T,M) n_CTA(T, M);
478 #define _CTA_1(T,F,L) _CTA_2(T, F, L)
479 #define _CTA_2(T,F,L) \
480 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
481 #define _LCTA_1(T,F,L) _LCTA_2(T, F, L)
482 #define _LCTA_2(T,F,L) \
484 typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
485 ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
486 UNUSED(__i_am_unused__);\
489 #define UNINIT(N,V) N = V
492 #define ISPOW2(X) ((((X) - 1) & (X)) == 0)
494 #define MIN(A, B) ((A) < (B) ? (A) : (B))
496 #define MAX(A, B) ((A) < (B) ? (B) : (A))
498 #define ABS(A) ((A) < 0 ? -(A) : (A))
500 /* Create a bit mask for the bit range LO..HI -- HI can't use highest bit! */
501 #define n_BITENUM_MASK(LO,HI) (((1u << ((HI) + 1)) - 1) & ~((1u << (LO)) - 1))
507 # define assert(X) UNUSED(0)
510 # define DBGOR(X,Y) Y
514 # define DBGOR(X,Y) X
517 /* Translation (init in main.c) */
526 * Types TODO v15: n_XX_t
530 # define UI8_MAX UINT8_MAX
531 # define SI8_MIN INT8_MIN
532 # define SI8_MAX INT8_MAX
533 typedef uint8_t ui8_t
;
534 typedef int8_t si8_t
;
535 #elif UCHAR_MAX != 255
536 # error UCHAR_MAX must be 255
538 # define UI8_MAX UCHAR_MAX
539 # define SI8_MIN CHAR_MIN
540 # define SI8_MAX CHAR_MAX
541 typedef unsigned char ui8_t
;
542 typedef signed char si8_t
;
545 #if !defined PRIu8 || !defined PRId8
553 # define UI16_MAX UINT16_MAX
554 # define SI16_MIN INT16_MIN
555 # define SI16_MAX INT16_MAX
556 typedef uint16_t ui16_t
;
557 typedef int16_t si16_t
;
558 #elif USHRT_MAX != 0xFFFFu
559 # error USHRT_MAX must be 0xFFFF
561 # define UI16_MAX USHRT_MAX
562 # define SI16_MIN SHRT_MIN
563 # define SI16_MAX SHRT_MAX
564 typedef unsigned short ui16_t
;
565 typedef signed short si16_t
;
568 #if !defined PRIu16 || !defined PRId16
571 # if UI16_MAX == UINT_MAX
581 # define UI32_MAX UINT32_MAX
582 # define SI32_MIN INT32_MIN
583 # define SI32_MAX INT32_MAX
584 typedef uint32_t ui32_t
;
585 typedef int32_t si32_t
;
586 #elif ULONG_MAX == 0xFFFFFFFFu
587 # define UI32_MAX ULONG_MAX
588 # define SI32_MIN LONG_MIN
589 # define SI32_MAX LONG_MAX
590 typedef unsigned long int ui32_t
;
591 typedef signed long int si32_t
;
592 #elif UINT_MAX != 0xFFFFFFFFu
593 # error UINT_MAX must be 0xFFFFFFFF
595 # define UI32_MAX UINT_MAX
596 # define SI32_MIN INT_MIN
597 # define SI32_MAX INT_MAX
598 typedef unsigned int ui32_t
;
599 typedef signed int si32_t
;
602 #if !defined PRIu32 || !defined PRId32
605 # if UI32_MAX == ULONG_MAX
615 # define UI64_MAX UINT64_MAX
616 # define SI64_MIN INT64_MIN
617 # define SI64_MAX INT64_MAX
618 typedef uint64_t ui64_t
;
619 typedef int64_t si64_t
;
620 #elif ULONG_MAX <= 0xFFFFFFFFu
621 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
622 # error We need a 64 bit integer
624 # define UI64_MAX ULLONG_MAX
625 # define SI64_MIN LLONG_MIN
626 # define SI64_MAX LLONG_MAX
627 __EXTEN
typedef unsigned long long ui64_t
;
628 __EXTEN
typedef signed long long si64_t
;
631 # define UI64_MAX ULONG_MAX
632 # define SI64_MIN LONG_MIN
633 # define SI64_MAX LONG_MAX
634 typedef unsigned long ui64_t
;
635 typedef signed long si64_t
;
638 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
642 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
643 # define PRIu64 "llu"
644 # define PRId64 "lld"
645 # define PRIX64 "llX"
653 /* (So that we can use UICMP() for size_t comparison, too) */
654 typedef size_t uiz_t
;
655 typedef ssize_t siz_t
;
659 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
662 # define UIZ_MAX SIZE_MAX
663 #elif defined SIZE_MAX
664 /* UnixWare has size_t as unsigned as required but uses a signed limit
665 * constant (which is thus false!) */
666 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
667 # define PRIuZ PRIu64
668 # define PRIdZ PRId64
669 n_MCTA(sizeof(size_t) == sizeof(ui64_t
),
670 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
671 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
672 # define PRIuZ PRIu32
673 # define PRIdZ PRId32
674 n_MCTA(sizeof(size_t) == sizeof(ui32_t
),
675 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
677 # error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
679 # define UIZ_MAX SIZE_MAX
684 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
685 "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
686 # define UIZ_MAX ULONG_MAX
691 # define uintptr_t size_t
692 # define UINTPTR_MAX SIZE_MAX
694 # define uintptr_t unsigned long
695 # define UINTPTR_MAX ULONG_MAX
699 #if !defined PRIuPTR || !defined PRIXPTR
702 # if UINTPTR_MAX == ULONG_MAX
703 # define PRIuPTR "lu"
704 # define PRIXPTR "lX"
711 #ifdef HAVE_C90AMEND1
712 typedef wchar_t wc_t
;
713 # define n_WC_C(X) L ## X
715 typedef char wc_t
; /* Yep: really 8-bit char */
719 enum {FAL0
, TRU1
, TRUM1
= -1};
720 typedef si8_t bool_t
;
722 /* Add shorter aliases for "normal" integers TODO v15 -> n_XX_t */
723 typedef unsigned long ul_i
;
724 typedef unsigned int ui_i
;
725 typedef unsigned short us_i
;
726 typedef unsigned char uc_i
;
728 typedef signed long sl_i
;
729 typedef signed int si_i
;
730 typedef signed short ss_i
;
731 typedef signed char sc_i
;
733 typedef void ( *sighandler_type
)(int); /* TODO v15 obsolete */
734 typedef void ( *n_sighdl_t
)(int);
737 AUTHTYPE_NONE
= 1<<0,
738 AUTHTYPE_PLAIN
= 1<<1, /* POP3: APOP is covered by this */
739 AUTHTYPE_LOGIN
= 1<<2,
740 AUTHTYPE_CRAM_MD5
= 1<<3,
741 AUTHTYPE_GSSAPI
= 1<<4
744 enum expand_addr_flags
{
745 EAF_NONE
= 0, /* -> EAF_NOFILE | EAF_NOPIPE */
746 EAF_RESTRICT
= 1<<0, /* "restrict" (do unless interaktive / -[~#]) */
747 EAF_FAIL
= 1<<1, /* "fail" */
748 /* Bits reused by enum expand_addr_check_mode! */
749 EAF_FILE
= 1<<3, /* +"file" targets */
750 EAF_PIPE
= 1<<4, /* +"pipe" command pipe targets */
751 EAF_NAME
= 1<<5, /* +"name"s (non-address) names / MTA aliases */
752 EAF_ADDR
= 1<<6, /* +"addr" network address (contain "@") */
754 EAF_TARGET_MASK
= EAF_FILE
| EAF_PIPE
| EAF_NAME
| EAF_ADDR
,
755 EAF_RESTRICT_TARGETS
= EAF_NAME
| EAF_ADDR
/* (default set if not set) */
758 enum expand_addr_check_mode
{
759 EACM_NONE
= 0, /* Don't care about *expandaddr* */
760 EACM_NORMAL
= 1<<0, /* Use our normal *expandaddr* checking */
761 EACM_STRICT
= 1<<1, /* Never allow any file or pipe addresse */
762 EACM_MODE_MASK
= 0x3, /* _NORMAL and _STRICT are mutual! */
764 EACM_NOLOG
= 1<<2, /* Don't log check errors */
766 /* Some special overwrites of EAF_TARGETs.
767 * May NOT clash with EAF_* bits which may be ORd to these here! */
772 enum n_cmd_arg_desc_flags
{/* TODO incomplete, misses getmsglist() */
774 n_CMD_ARG_DESC_STRING
= 1<<0, /* A !blankspacechar() string */
775 n_CMD_ARG_DESC_WYSH
= 1<<1, /* sh(1)ell-style quoted */
777 n__CMD_ARG_DESC_TYPE_MASK
= n_CMD_ARG_DESC_STRING
| n_CMD_ARG_DESC_WYSH
,
779 /* - Optional flags */
780 /* It is not an error if an optional argument is missing; once an argument
781 * has been declared optional only optional arguments may follow */
782 n_CMD_ARG_DESC_OPTION
= 1<<16,
783 /* GREEDY: parse as many of that type as possible; must be last entry */
784 n_CMD_ARG_DESC_GREEDY
= 1<<17,
785 /* Honour an overall "stop" request in one of the arguments (\c@ or #) */
786 n_CMD_ARG_DESC_HONOUR_STOP
= 1<<18,
788 n__CMD_ARG_DESC_FLAG_MASK
= n_CMD_ARG_DESC_OPTION
| n_CMD_ARG_DESC_GREEDY
|
789 n_CMD_ARG_DESC_HONOUR_STOP
793 /* We do have several contexts of colour IDs; since only one of them can be
794 * active at any given time let's share the value range */
804 n_COLOUR_ID_SUM_DOTMARK
= 0,
805 n_COLOUR_ID_SUM_HEADER
,
806 n_COLOUR_ID_SUM_THREAD
,
808 /* Message display */
809 n_COLOUR_ID_VIEW_FROM_
= 0,
810 n_COLOUR_ID_VIEW_HEADER
,
811 n_COLOUR_ID_VIEW_MSGINFO
,
812 n_COLOUR_ID_VIEW_PARTINFO
,
814 /* Mailx-Line-Editor */
815 n_COLOUR_ID_MLE_POSITION
= 0,
816 n_COLOUR_ID_MLE_PROMPT
,
818 n__COLOUR_IDS
= n_COLOUR_ID_VIEW_PARTINFO
+ 1
821 /* Colour preconditions, let's call them tags, cannot be an enum because for
822 * message display they are the actual header name of the current header. Thus
823 * let's use constants of pseudo pointers */
824 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
825 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
826 #endif /* HAVE_COLOUR */
829 CONV_NONE
, /* no conversion */
830 CONV_7BIT
, /* no conversion, is 7bit */
831 CONV_FROMQP
, /* convert from quoted-printable */
832 CONV_TOQP
, /* convert to quoted-printable */
833 CONV_8BIT
, /* convert to 8bit (iconv) */
834 CONV_FROMB64
, /* convert from base64 */
835 CONV_FROMB64_T
, /* convert from base64/text */
836 CONV_TOB64
, /* convert to base64 */
837 CONV_FROMHDR
, /* convert from RFC1522 format */
838 CONV_TOHDR
, /* convert to RFC1522 format */
839 CONV_TOHDR_A
/* convert addresses for header */
847 enum n_dotlock_state
{
849 n_DLS_CANT_CHDIR
, /* Failed to chdir(2) into desired path */
850 n_DLS_NAMETOOLONG
, /* Lock file name would be too long */
851 n_DLS_ROFS
, /* Read-only filesystem (no error, mailbox RO) */
852 n_DLS_NOPERM
, /* No permission to creat lock file */
853 n_DLS_NOEXEC
, /* Privilege separated dotlocker not found */
854 n_DLS_PRIVFAILED
, /* Rising privileges failed in dotlocker */
855 n_DLS_EXIST
, /* Lock file already exists, stale lock? */
856 n_DLS_FISHY
, /* Something makes us think bad of situation */
857 n_DLS_DUNNO
, /* Catch-all error */
858 n_DLS_PING
, /* Not an error, but have to wait for lock */
859 n_DLS_ABANDON
= 1<<7 /* ORd to any but _NONE: give up, don't retry */
863 EXIT_OK
= EXIT_SUCCESS
,
864 EXIT_ERR
= EXIT_FAILURE
,
865 EXIT_USE
= 64, /* sysexits.h:EX_USAGE */
866 EXIT_NOUSER
= 67, /* :EX_NOUSER */
867 EXIT_COLL_ABORT
= 1<<1, /* Message collection was aborted */
868 EXIT_SEND_ERROR
= 1<<2 /* Unspecified send error occurred */
873 FEDIT_SYSBOX
= 1<<0, /* %: prefix */
874 FEDIT_RDONLY
= 1<<1, /* Readonly (per-box, OPT_R_FLAG is global) */
875 FEDIT_NEWMAIL
= 1<<2 /* `newmail' operation TODO OBSOLETE THIS! */
879 FEXP_FULL
, /* Full expansion */
880 FEXP_NOPROTO
= 1<<0, /* TODO no which_protocol() to decide expansion */
881 FEXP_LOCAL
= 1<<1, /* Result must be local file/maildir */
882 FEXP_NSHORTCUT
= 1<<2, /* Don't expand shortcuts */
883 FEXP_SILENT
= 1<<3, /* Don't print but only return errors */
884 FEXP_MULTIOK
= 1<<4, /* Expansion to many entries is ok */
885 FEXP_NSHELL
= 1<<5, /* Don't do shell word exp. (but ~/, $VAR) */
886 FEXP_NVAR
= 1<<6 /* ..not even $VAR expansion */
889 enum n_file_lock_type
{
895 MIME_UNKNOWN
, /* unknown content */
896 MIME_SUBHDR
, /* inside a multipart subheader */
897 MIME_822
, /* message/rfc822 content */
898 MIME_MESSAGE
, /* other message/ content */
899 MIME_TEXT_PLAIN
, /* text/plain content */
900 MIME_TEXT_HTML
, /* text/html content */
901 MIME_TEXT
, /* other text/ content */
902 MIME_ALTERNATIVE
, /* multipart/alternative content */
903 MIME_RELATED
, /* mime/related (RFC 2387) */
904 MIME_DIGEST
, /* multipart/digest content */
905 MIME_MULTI
, /* other multipart/ content */
906 MIME_PKCS7
, /* PKCS7 content */
907 MIME_DISCARD
/* content is discarded */
910 enum mime_counter_evidence
{
912 MIMECE_SET
= 1<<0, /* *mime-counter-evidence* was set */
913 MIMECE_BIN_OVWR
= 1<<1, /* appli../octet-stream: check, ovw if possible */
914 MIMECE_ALL_OVWR
= 1<<2, /* all: check, ovw if possible */
915 MIMECE_BIN_PARSE
= 1<<3 /* appli../octet-stream: classify contents last */
918 /* Content-Transfer-Encodings as defined in RFC 2045:
919 * - Quoted-Printable, section 6.7
920 * - Base64, section 6.8 */
921 #define QP_LINESIZE (4 * 19) /* Max. compliant QP linesize */
923 #define B64_LINESIZE (4 * 19) /* Max. compliant Base64 linesize */
924 #define B64_ENCODE_INPUT_PER_LINE 57 /* Max. input for Base64 encode/line */
927 MIMEE_NONE
, /* message is not in MIME format */
928 MIMEE_BIN
, /* message is in binary encoding */
929 MIMEE_8B
, /* message is in 8bit encoding */
930 MIMEE_7B
, /* message is in 7bit encoding */
931 MIMEE_QP
, /* message is quoted-printable */
932 MIMEE_B64
/* message is in base64 encoding */
935 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
936 enum mime_enc_flags
{
938 MIMEEF_SALLOC
= 1<<0, /* Use salloc(), not srealloc().. */
939 /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
941 MIMEEF_CRLF
= 1<<2, /* (encode) Append "\r\n" to lines */
942 MIMEEF_LF
= 1<<3, /* (encode) Append "\n" to lines */
943 /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
944 * inject the desired line-ending whenever a linewrap is desired */
945 MIMEEF_MULTILINE
= 1<<4,
946 /* (encode) Quote with header rules, do not generate soft NL breaks?
947 * For mustquote(), specifies wether special RFC 2047 header rules
948 * should be used instead */
949 MIMEEF_ISHEAD
= 1<<5,
950 /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
951 * that characters which would not be reported as "must-quote" when
952 * detecting wether quoting is necessary at all will be reported as
953 * "must-quote" if they have to be encoded in an encoded word */
954 MIMEEF_ISENCWORD
= 1<<6,
959 QP_NONE
= MIMEEF_NONE
,
960 QP_SALLOC
= MIMEEF_SALLOC
,
962 QP_ISHEAD
= MIMEEF_ISHEAD
,
963 QP_ISENCWORD
= MIMEEF_ISENCWORD
967 B64_NONE
= MIMEEF_NONE
,
968 B64_SALLOC
= MIMEEF_SALLOC
,
969 B64_BUF
= MIMEEF_BUF
,
970 B64_CRLF
= MIMEEF_CRLF
,
972 B64_MULTILINE
= MIMEEF_MULTILINE
,
973 /* Not used, but for clarity only */
974 B64_ISHEAD
= MIMEEF_ISHEAD
,
975 B64_ISENCWORD
= MIMEEF_ISENCWORD
,
976 /* Special version of Base64, "Base64URL", according to RFC 4648.
977 * Only supported for encoding! */
978 B64_RFC4648URL
= 1<<(__MIMEEF_LAST
+1),
979 /* Don't use any ("=") padding;
980 * may NOT be used with any of _CRLF, _LF or _MULTILINE */
981 B64_NOPAD
= 1<<(__MIMEEF_LAST
+2)
984 enum mime_parse_flags
{
986 MIME_PARSE_DECRYPT
= 1<<0,
987 MIME_PARSE_PARTS
= 1<<1
990 enum mime_handler_flags
{
991 MIME_HDL_NULL
, /* No pipe- mimetype handler, go away */
992 MIME_HDL_CMD
, /* Normal command */
993 MIME_HDL_TEXT
, /* @ special cmd to force treatment as text */
994 MIME_HDL_PTF
, /* A special pointer-to-function handler */
995 MIME_HDL_MSG
, /* Display msg (returned as command string) */
996 MIME_HDL_TYPE_MASK
= 7,
997 MIME_HDL_ISQUOTE
= 1<<4, /* Is quote action (we have info, keep it!) */
998 MIME_HDL_NOQUOTE
= 1<<5, /* No MIME for quoting */
999 MIME_HDL_ALWAYS
= 1<<6, /* Handler shall run for multi-msg actions */
1000 MIME_HDL_ASYNC
= 1<<7, /* Should run asynchronously */
1001 MIME_HDL_NEEDSTERM
= 1<<8, /* Takes over terminal */
1002 MIME_HDL_TMPF
= 1<<9, /* Create temporary file (zero-sized) */
1003 MIME_HDL_TMPF_FILL
= 1<<10, /* Fill in the msg body content */
1004 MIME_HDL_TMPF_UNLINK
= 1<<11 /* Delete it later again */
1008 MLIST_OTHER
= 0, /* Normal address */
1009 MLIST_KNOWN
= 1, /* A known `mlist' */
1010 MLIST_SUBSCRIBED
= -1 /* A `mlsubscribe'd list */
1021 OF_CLOEXEC
= 1<<7, /* TODO not used, always implied! CHANGE!! */
1022 OF_UNLINK
= 1<<8, /* Only for Ftmp(): unlink(2) after creation */
1023 OF_HOLDSIGS
= 1<<9, /* Mutual with OF_UNLINK - await Ftmp_free() */
1024 OF_REGISTER
= 1<<10, /* Register file in our file table */
1025 OF_REGISTER_UNLINK
= 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
1026 OF_SUFFIX
= 1<<12 /* Ftmp() name hint is mandatory! extension! */
1034 enum okey_xlook_mode
{
1035 OXM_PLAIN
= 1<<0, /* Plain key always tested */
1036 OXM_H_P
= 1<<1, /* Check PLAIN-.url_h_p */
1037 OXM_U_H_P
= 1<<2, /* Check PLAIN-.url_u_h_p */
1041 /* <0 means "stop" unless *prompt* extensions are enabled. */
1043 PROMPT_STOP
= -1, /* \c */
1044 /* *prompt* extensions: \$, \@ etc. */
1050 PROTO_FILE
, /* refers to a local file */
1051 PROTO_POP3
, /* is a pop3 server string */
1052 PROTO_MAILDIR
, /* refers to a maildir folder */
1053 PROTO_UNKNOWN
/* unknown protocol */
1057 SEND_MBOX
, /* no conversion to perform */
1058 SEND_RFC822
, /* no conversion, no From_ line */
1059 SEND_TODISP
, /* convert to displayable form */
1060 SEND_TODISP_ALL
, /* same, include all MIME parts */
1061 SEND_SHOW
, /* convert to 'show' command form */
1062 SEND_TOSRCH
, /* convert for IMAP SEARCH */
1063 SEND_TOFILE
, /* convert for saving body to a file */
1064 SEND_TOPIPE
, /* convert for pipe-content/subc. */
1065 SEND_QUOTE
, /* convert for quoting */
1066 SEND_QUOTE_ALL
, /* same, include all MIME parts */
1067 SEND_DECRYPT
/* decrypt */
1070 enum n_shexp_parse_flags
{
1072 /* Don't perform any expansions or interpret backslash escape sequences etc.
1073 * Output may be NULL, otherwise the possibly trimmed non-expanded input is
1075 n_SHEXP_PARSE_DRYRUN
= 1<<0,
1076 n_SHEXP_PARSE_TRUNC
= 1<<1, /* Truncate result storage on entry */
1077 n_SHEXP_PARSE_TRIMSPACE
= 1<<2, /* Ignore space surrounding tokens */
1078 n_SHEXP_PARSE_LOG
= 1<<3, /* Log errors */
1079 n_SHEXP_PARSE_LOG_D_V
= 1<<4, /* Log errors if OPT_D_V */
1080 n_SHEXP_PARSE_IFS_ADD_COMMA
= 1<<5, /* Add comma , to normal "IFS" */
1081 n_SHEXP_PARSE_IFS_IS_COMMA
= 1<<6, /* Let comma , be the sole "IFS" */
1082 n_SHEXP_PARSE_IGNORE_EMPTY
= 1<<7, /* Ignore empty tokens, start over */
1083 n__SHEXP_PARSE_LAST
= 7
1088 /* We have produced some output (or would have, with _PARSE_DRYRUN).
1089 * Note that empty quotes like '' produce no output but set this bit */
1090 n_SHEXP_STATE_OUTPUT
= 1<<2,
1091 /* Don't call the parser again (\c0 or # comment seen; out of input).
1092 * Not (necessarily) mutual with _OUTPUT) */
1093 n_SHEXP_STATE_STOP
= 1<<1,
1094 n_SHEXP_STATE_UNICODE
= 1<<3, /* \[Uu] used */
1095 n_SHEXP_STATE_CONTROL
= 1<<4, /* Control characters seen */
1097 n_SHEXP_STATE_ERR_CONTROL
= 1<<16, /* \c notation with invalid argument */
1098 n_SHEXP_STATE_ERR_UNICODE
= 1<<17, /* Valid \[Uu] used and !OPT_UNICODE */
1099 n_SHEXP_STATE_ERR_NUMBER
= 1<<18, /* Bad number (\[UuXx]) */
1100 n_SHEXP_STATE_ERR_BRACE
= 1<<19, /* _QUOTEOPEN + no } brace for ${VAR */
1101 n_SHEXP_STATE_ERR_BADSUB
= 1<<20, /* Empty/bad ${} substitution */
1102 n_SHEXP_STATE_ERR_QUOTEOPEN
= 1<<21, /* Quote remains open at EOS */
1104 n_SHEXP_STATE_ERR_MASK
= n_BITENUM_MASK(16, 21)
1107 enum n_sigman_flags
{
1109 n_SIGMAN_HUP
= 1<<0,
1110 n_SIGMAN_INT
= 1<<1,
1111 n_SIGMAN_QUIT
= 1<<2,
1112 n_SIGMAN_TERM
= 1<<3,
1113 n_SIGMAN_PIPE
= 1<<4,
1115 n_SIGMAN_IGN_HUP
= 1<<5,
1116 n_SIGMAN_IGN_INT
= 1<<6,
1117 n_SIGMAN_IGN_QUIT
= 1<<7,
1118 n_SIGMAN_IGN_TERM
= 1<<8,
1120 n_SIGMAN_ALL
= 0xFF,
1121 /* Mostly for _leave() reraise flags */
1122 n_SIGMAN_VIPSIGS
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1124 n_SIGMAN_NTTYOUT_PIPE
= 1<<16,
1125 n_SIGMAN_VIPSIGS_NTTYOUT
= n_SIGMAN_HUP
| n_SIGMAN_INT
| n_SIGMAN_QUIT
|
1126 n_SIGMAN_TERM
| n_SIGMAN_NTTYOUT_PIPE
,
1128 n__SIGMAN_PING
= 1<<17
1132 enum ssl_verify_level
{
1141 TD_NONE
, /* no display conversion */
1142 TD_ISPR
= 1<<0, /* use isprint() checks */
1143 TD_ICONV
= 1<<1, /* use iconv() */
1144 TD_DELCTRL
= 1<<2, /* delete control characters */
1147 * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1148 * enum sendaction, and may thus NOT clash with their bit range!
1150 _TD_EOF
= 1<<14, /* EOF seen, last round! */
1151 _TD_BUFCOPY
= 1<<15 /* Buffer may be constant, copy it */
1155 enum n_termcap_captype
{
1156 n_TERMCAP_CAPTYPE_NONE
= 0,
1157 /* Internally we share the bitspace, so ensure no value ends up as 0 */
1158 n_TERMCAP_CAPTYPE_BOOL
= 1,
1159 n_TERMCAP_CAPTYPE_NUMERIC
,
1160 n_TERMCAP_CAPTYPE_STRING
,
1161 n__TERMCAP_CAPTYPE_MAX
1164 /* Termcap commands; different to queries commands perform actions.
1165 * Commands are resolved upon init time, and are all termcap(5)-compatible,
1166 * therefore we use the short termcap(5) names.
1167 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1168 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1169 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1170 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1171 * We may use the free-form part after | for the "Variable String" and notes on
1172 * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1173 * regular but are only used when the command, i.e., its effect, is somehow
1174 * simulated / faked by a builtin fallback implementation.
1175 * Availability of builtin fallback indicated by leading @ (at-sign) */
1177 # ifdef HAVE_TERMCAP
1178 n_TERMCAP_CMD_te
, /* rmcup/te, STRING | exit_ca_mode: -,- */
1179 n_TERMCAP_CMD_ti
, /* smcup/ti, STRING | enter_ca_mode: -,- */
1181 n_TERMCAP_CMD_ks
, /* smkx/ks, STRING | keypad_xmit: -,- */
1182 n_TERMCAP_CMD_ke
, /* rmkx/ke, STRING | keypad_local: -,- */
1184 n_TERMCAP_CMD_cd
, /* ed/cd, STRING | clr_eos: -,- */
1185 n_TERMCAP_CMD_cl
, /* clear/cl, STRING | clear_screen(+home): -,- */
1186 n_TERMCAP_CMD_ho
, /* home/ho, STRING | cursor_home: -,- */
1190 n_TERMCAP_CMD_ce
, /* el/ce, STRING | @ clr_eol: [start-column],- */
1191 n_TERMCAP_CMD_ch
, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1192 n_TERMCAP_CMD_cr
, /* cr/cr, STRING | @ carriage_return: -,- */
1193 n_TERMCAP_CMD_le
, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1194 n_TERMCAP_CMD_nd
, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1198 n__TERMCAP_CMD_MASK
= (1<<24) - 1,
1200 /* Only perform command if ca-mode is used */
1201 n_TERMCAP_CMD_FLAG_CA_MODE
= 1<<29,
1202 /* I/O should be flushed after command completed */
1203 n_TERMCAP_CMD_FLAG_FLUSH
= 1<<30
1206 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1207 * Queries are resolved once they are used first, and may not be termcap(5)-
1208 * compatible, therefore we use terminfo(5) names.
1209 * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1210 * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1211 * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1212 * a | vertical bar or end-of-comment ends processing; see termcap.c.
1213 * We may use the free-form part after | for the "Variable String" and notes.
1214 * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1215 enum n_termcap_query
{
1217 n_TERMCAP_QUERY_colors
, /* colors/Co, NUMERIC | max_colors */
1220 /* --mk-tcap-map--: only KEY_BINDINGS follow. DON'T CHANGE THIS LINE! */
1221 /* Update the `bind' manual on change! */
1222 # ifdef HAVE_KEY_BINDINGS
1223 n_TERMCAP_QUERY_key_backspace
, /* kbs/kb, STRING */
1224 n_TERMCAP_QUERY_key_dc
, /* kdch1/kD, STRING | delete-character */
1225 n_TERMCAP_QUERY_key_sdc
, /* kDC / *4, STRING | ..shifted */
1226 n_TERMCAP_QUERY_key_eol
, /* kel/kE, STRING | clear-to-end-of-line */
1227 n_TERMCAP_QUERY_key_exit
, /* kext/@9, STRING */
1228 n_TERMCAP_QUERY_key_ic
, /* kich1/kI, STRING | insert character */
1229 n_TERMCAP_QUERY_key_sic
, /* kIC/#3, STRING | ..shifted */
1230 n_TERMCAP_QUERY_key_home
, /* khome/kh, STRING */
1231 n_TERMCAP_QUERY_key_shome
, /* kHOM/#2, STRING | ..shifted */
1232 n_TERMCAP_QUERY_key_end
, /* kend/@7, STRING */
1233 n_TERMCAP_QUERY_key_send
, /* kEND / *7, STRING | ..shifted */
1234 n_TERMCAP_QUERY_key_npage
, /* knp/kN, STRING */
1235 n_TERMCAP_QUERY_key_ppage
, /* kpp/kP, STRING */
1236 n_TERMCAP_QUERY_key_left
, /* kcub1/kl, STRING */
1237 n_TERMCAP_QUERY_key_sleft
, /* kLFT/#4, STRING | ..shifted */
1238 n_TERMCAP_QUERY_xkey_aleft
, /* kLFT3/-, STRING | X: Alt+left */
1239 n_TERMCAP_QUERY_xkey_cleft
, /* kLFT5/-, STRING | X: Control+left */
1240 n_TERMCAP_QUERY_key_right
, /* kcuf1/kr, STRING */
1241 n_TERMCAP_QUERY_key_sright
, /* kRIT/%i, STRING | ..shifted */
1242 n_TERMCAP_QUERY_xkey_aright
, /* kRIT3/-, STRING | X: Alt+right */
1243 n_TERMCAP_QUERY_xkey_cright
, /* kRIT5/-, STRING | X: Control+right */
1244 n_TERMCAP_QUERY_key_down
, /* kcud1/kd, STRING */
1245 n_TERMCAP_QUERY_xkey_sdown
, /* kDN/-, STRING | ..shifted */
1246 n_TERMCAP_QUERY_xkey_adown
, /* kDN3/-, STRING | X: Alt+down */
1247 n_TERMCAP_QUERY_xkey_cdown
, /* kDN5/-, STRING | X: Control+down */
1248 n_TERMCAP_QUERY_key_up
, /* kcuu1/ku, STRING */
1249 n_TERMCAP_QUERY_xkey_sup
, /* kUP/-, STRING | ..shifted */
1250 n_TERMCAP_QUERY_xkey_aup
, /* kUP3/-, STRING | X: Alt+up */
1251 n_TERMCAP_QUERY_xkey_cup
, /* kUP5/-, STRING | X: Control+up */
1252 n_TERMCAP_QUERY_kf0
, /* kf0/k0, STRING */
1253 n_TERMCAP_QUERY_kf1
, /* kf1/k1, STRING */
1254 n_TERMCAP_QUERY_kf2
, /* kf2/k2, STRING */
1255 n_TERMCAP_QUERY_kf3
, /* kf3/k3, STRING */
1256 n_TERMCAP_QUERY_kf4
, /* kf4/k4, STRING */
1257 n_TERMCAP_QUERY_kf5
, /* kf5/k5, STRING */
1258 n_TERMCAP_QUERY_kf6
, /* kf6/k6, STRING */
1259 n_TERMCAP_QUERY_kf7
, /* kf7/k7, STRING */
1260 n_TERMCAP_QUERY_kf8
, /* kf8/k8, STRING */
1261 n_TERMCAP_QUERY_kf9
, /* kf9/k9, STRING */
1262 n_TERMCAP_QUERY_kf10
, /* kf10/k;, STRING */
1263 n_TERMCAP_QUERY_kf11
, /* kf11/F1, STRING */
1264 n_TERMCAP_QUERY_kf12
, /* kf12/F2, STRING */
1265 n_TERMCAP_QUERY_kf13
, /* kf13/F3, STRING */
1266 n_TERMCAP_QUERY_kf14
, /* kf14/F4, STRING */
1267 n_TERMCAP_QUERY_kf15
, /* kf15/F5, STRING */
1268 n_TERMCAP_QUERY_kf16
, /* kf16/F6, STRING */
1269 n_TERMCAP_QUERY_kf17
, /* kf17/F7, STRING */
1270 n_TERMCAP_QUERY_kf18
, /* kf18/F8, STRING */
1271 n_TERMCAP_QUERY_kf19
, /* kf19/F9, STRING */
1272 # endif /* HAVE_KEY_BINDINGS */
1274 n__TERMCAP_QUERY_MAX
1276 #endif /* n_HAVE_TCAP */
1278 enum n_visual_info_flags
{
1280 n_VISUAL_INFO_ONE_CHAR
= 1<<0, /* Step only one char, then return */
1281 n_VISUAL_INFO_SKIP_ERRORS
= 1<<1, /* Treat via replacement, step byte */
1282 n_VISUAL_INFO_WIDTH_QUERY
= 1<<2, /* Detect visual character widths */
1284 /* Rest only with HAVE_C90AMEND1, mutual with _ONE_CHAR */
1285 n_VISUAL_INFO_WOUT_CREATE
= 1<<8, /* Use/create .vic_woudat */
1286 n_VISUAL_INFO_WOUT_SALLOC
= 1<<9, /* ..salloc() it first */
1287 /* Only visuals into .vic_woudat - implies _WIDTH_QUERY */
1288 n_VISUAL_INFO_WOUT_PRINTABLE
= 1<<10,
1289 n__VISUAL_INFO_FLAGS
= n_VISUAL_INFO_WOUT_CREATE
|
1290 n_VISUAL_INFO_WOUT_SALLOC
| n_VISUAL_INFO_WOUT_PRINTABLE
1295 OPT_DEBUG
= 1u<< 0, /* -d / *debug* */
1296 OPT_VERB
= 1u<< 1, /* -v / *verbose* */
1297 OPT_VERBVERB
= 1u<< 2, /* .. even more verbosity */
1298 OPT_EXISTONLY
= 1u<< 3, /* -e */
1299 OPT_HEADERSONLY
= 1u<<4, /* -H */
1300 OPT_HEADERLIST
= 1u<< 5, /* -L */
1301 OPT_QUICKRUN_MASK
= OPT_EXISTONLY
| OPT_HEADERSONLY
| OPT_HEADERLIST
,
1302 OPT_E_FLAG
= 1u<< 7, /* -E / *skipemptybody* */
1303 OPT_F_FLAG
= 1u<< 8, /* -F */
1304 OPT_Mm_FLAG
= 1u<< 9, /* -M or -m (plus option_Mm_arg) */
1305 OPT_N_FLAG
= 1u<<10, /* -N / *header* */
1306 OPT_R_FLAG
= 1u<<11, /* -R */
1307 OPT_r_FLAG
= 1u<<12, /* -r (plus option_r_arg) */
1308 OPT_t_FLAG
= 1u<<13, /* -t */
1309 OPT_TILDE_FLAG
= 1u<<14, /* -~ */
1310 OPT_BATCH_FLAG
= 1u<<15, /* -# */
1313 OPT_MEMDEBUG
= 1<<16, /* *memdebug* */
1316 OPT_SENDMODE
= 1u<<17, /* Usage case forces send mode */
1318 OPT_TTYOUT
= 1u<<19,
1319 OPT_INTERACTIVE
= 1u<<20,
1320 OPT_UNICODE
= 1u<<21, /* We're in an UTF-8 environment */
1321 OPT_ENC_MBSTATE
= 1u<<22, /* Multibyte environment with shift states */
1323 /* Some easy-access shortcuts */
1324 OPT_D_V
= OPT_DEBUG
| OPT_VERB
,
1325 OPT_D_VV
= OPT_DEBUG
| OPT_VERBVERB
,
1326 OPT_D_V_VV
= OPT_DEBUG
| OPT_VERB
| OPT_VERBVERB
1329 #define OBSOLETE(X) \
1331 if (options & OPT_D_V_VV)\
1332 n_err("%s: %s\n", _("Obsoletion warning"), X);\
1334 #define OBSOLETE2(X,Y) \
1336 if (options & OPT_D_V_VV)\
1337 n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1340 enum program_state
{
1342 PS_STARTED
= 1<< 0, /* main.c startup code passed, functional */
1343 PS_ROOT
= 1<<30, /* Temporary "bypass any checks" bit */
1345 PS_EXIT
= 1<< 1, /* Exit request pending */
1346 PS_SOURCING
= 1<< 2, /* During load() or `source' */
1347 PS_RECURSED
= 1<< 3, /* State machine recursed, e.g. `~:CMD' */
1348 PS_ROBOT
= 1<< 4, /* State machine in non-interactive state */
1350 PS_EVAL_ERROR
= 1<< 5, /* Last evaluate() command failed */
1352 PS_HOOK_NEWMAIL
= 1<< 6,
1354 PS_HOOK_MASK
= PS_HOOK_NEWMAIL
| PS_HOOK
,
1356 PS_EDIT
= 1<< 8, /* Current mailbox not a "system mailbox" */
1357 PS_SETFILE_OPENED
= 1<< 9, /* (hack) setfile() opened a new box */
1358 PS_SAW_COMMAND
= 1<<10, /* ..after mailbox switch */
1360 PS_DID_PRINT_DOT
= 1<<12, /* Current message has been printed */
1362 PS_SIGWINCH_PEND
= 1<<14, /* Need update of $COLUMNS/$LINES */
1363 PS_PSTATE_PENDMASK
= PS_SIGWINCH_PEND
, /* pstate housekeeping needed */
1365 PS_ARGLIST_MASK
= n_BITENUM_MASK(17, 18),
1366 PS_MSGLIST_SAW_NO
= 1<<17, /* Last *LIST saw numerics */
1367 PS_MSGLIST_DIRECT
= 1<<18, /* One msg was directly chosen by number */
1368 PS_WYSHLIST_SAW_UNICODE
= 1<<17, /* ARG_WYSHLIST saw \[Uu] */
1369 PS_WYSHLIST_SAW_CONTROL
= 1<<18, /* ..saw C0+ control characters */
1371 PS_EXPAND_MULTIRESULT
= 1<<19, /* Last fexpand() with MULTIOK had .. */
1373 PS_HEADER_NEEDED_MIME
= 1<<20, /* mime_write_tohdr() needed x TODO HACK! */
1375 PS_COLOUR_ACTIVE
= 1<<22, /* n_colour_env_create().._gut() cycle */
1377 /* Various first-time-init switches */
1378 PS_ERRORS_NOTED
= 1<<24, /* Ring of `errors' content, print msg */
1379 PS_t_FLAG
= 1<<26, /* OPT_t_FLAG made persistant */
1380 PS_TERMCAP_DISABLE
= 1<<27, /* HAVE_TERMCAP: *termcap-disable* was set */
1381 PS_TERMCAP_CA_MODE
= 1<<28, /* HAVE_TERMCAP: ca_mode available & used */
1382 PS_HISTORY_LOADED
= 1<<29 /* Command line editor history loaded */
1385 /* A large enum with all the boolean and value options a.k.a their keys.
1386 * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1387 * ok_[bv]set() and ok_[bv]clear().
1389 * - see the comments in accmacvar.c before changing *anything* in here!
1390 * - virt= implies rdonly,nodel
1391 * - import= implies env
1392 * - defval= implies notempty
1393 * - num and posnum are mutual exclusive
1394 * - most default VAL_ues come from in from build system via ./make.rc
1395 * (Keep in SYNC: ./nail.h:okeys, ./nail.rc, ./nail.1:"Initial settings") */
1397 /* TODO likely temporary hook data, v15 drop */
1398 ok_v_on_compose_enter
,
1399 ok_v_on_compose_leave
,
1401 ok_v_compose_sender
,
1405 ok_v_compose_subject
,
1407 ok_b_add_file_recipients
,
1408 ok_v_agent_shell_lookup
,
1417 ok_b_asksub
, /* {i3val=TRU1} */
1418 ok_b_attachment_ask_content_description
,
1419 ok_b_attachment_ask_content_disposition
,
1420 ok_b_attachment_ask_content_id
,
1421 ok_b_attachment_ask_content_type
,
1431 ok_b_batch_exit_on_error
,
1439 ok_v_COLUMNS
, /* {notempty=1,posnum=1,env=1} */
1442 ok_v_charset_unknown_8bit
,
1444 ok_b_colour_disable
,
1446 ok_v_crt
, /* {posnum=1} */
1447 ok_v_customhdr
, /* {nocntrls=1} */
1449 ok_v_DEAD
, /* {env=1,defval=VAL_DEAD} */
1451 ok_v_datefield_markout_older
,
1452 ok_b_debug
, /* {vip=1} */
1453 ok_b_disposition_notification_send
,
1455 ok_b_dotlock_ignore_error
,
1457 ok_v_EDITOR
, /* {env=1,defval=VAL_EDITOR} */
1467 ok_v_features
, /* {virt=_features} */
1469 ok_v_folder
, /* {vip=1} */
1470 ok_v__folder_resolved
, /* {rdonly=1,nodel=1} */
1473 ok_v_followup_to_honour
,
1474 ok_b_forward_as_attachment
,
1479 ok_v_HOME
, /* {vip=1,nodel=1,import=1} */
1480 ok_b_header
, /* {vip=1,i3val=TRU1} */
1485 ok_b_history_gabby_persist
,
1486 ok_v_history_size
, /* {notempty=1,num=1} */
1496 ok_b_keep_content_length
,
1499 ok_v_LINES
, /* {notempty=1,posnum=1,env=1} */
1500 ok_v_LISTER
, /* {env=1,defval=VAL_LISTER} */
1501 ok_v_LOGNAME
, /* {rdonly=1,import=1} */
1502 ok_b_line_editor_disable
,
1504 ok_v_MAIL
, /* {env=1} */
1505 ok_v_MAILRC
, /* {import=1,defval=VAL_MAILRC} */
1506 ok_v_MBOX
, /* {env=1,defval=VAL_MBOX} */
1509 ok_b_memdebug
, /* {vip=1} */
1510 ok_b_message_id_disable
,
1511 ok_v_message_inject_head
,
1512 ok_v_message_inject_tail
,
1514 ok_b_mime_allow_text_controls
,
1515 ok_b_mime_alternative_favour_rich
,
1516 ok_v_mime_counter_evidence
, /* {posnum=1} */
1517 ok_v_mimetypes_load_control
,
1519 ok_v_NAIL_EXTRA_RC
, /* {name=NAIL_EXTRA_RC} */
1520 ok_b_NAIL_NO_SYSTEM_RC
, /* {import=1} */
1521 ok_v_NAIL_HEAD
, /* {name=NAIL_HEAD} */
1522 ok_v_NAIL_HISTFILE
, /* {name=NAIL_HISTFILE} */
1523 ok_v_NAIL_HISTSIZE
, /* {name=NAIL_HISTSIZE,notempty=1,num=1} */
1524 ok_v_NAIL_TAIL
, /* {name=NAIL_TAIL} */
1525 ok_v_NETRC
, /* {env=1,defval=VAL_NETRC} */
1533 ok_v_PAGER
, /* {env=1,defval=VAL_PAGER} */
1534 ok_v_PATH
, /* {nodel=1,import=1} */
1539 ok_b_pop3_bulk_load
,
1540 ok_v_pop3_keepalive
,
1542 ok_b_pop3_use_starttls
,
1543 ok_b_print_alternatives
,
1544 ok_v_prompt
, /* {i3val="\\& "} */
1548 ok_b_quote_as_attachment
,
1551 ok_b_recipients_in_cc
,
1554 ok_b_reply_in_same_charset
,
1557 ok_v_reply_to_honour
,
1558 ok_b_rfc822_body_from_
, /* {name=rfc822-body-from_} */
1560 ok_v_SHELL
, /* {import=1,defval=VAL_SHELL} */
1561 ok_b_SYSV3
, /* {env=1} */
1562 ok_b_save
, /* {i3val=TRU1} */
1563 ok_v_screen
, /* {notempty=1,posnum=1} */
1566 ok_b_sendcharsets_else_ttycharset
,
1568 ok_v_sendmail
, /* {defval=VAL_SENDMAIL} */
1569 ok_v_sendmail_arguments
,
1570 ok_b_sendmail_no_default_arguments
,
1571 ok_v_sendmail_progname
, /* {defval=VAL_SENDMAIL_PROGNAME} */
1579 ok_b_skipemptybody
, /* {vip=1} */
1584 ok_v_smime_crl_file
,
1585 /* smime-encrypt-USER@HOST */
1586 ok_b_smime_force_encryption
,
1587 ok_b_smime_no_default_ca
,
1589 ok_v_smime_sign_cert
,
1590 ok_v_smime_sign_include_certs
,
1591 ok_v_smime_sign_message_digest
,
1594 ok_v_smtp_auth_password
,
1595 ok_v_smtp_auth_user
,
1597 ok_b_smtp_use_starttls
,
1598 ok_v_spam_interface
,
1599 ok_v_spam_maxsize
, /* {notempty=1,posnum=1} */
1601 ok_v_spamc_arguments
,
1605 ok_v_spamfilter_ham
,
1606 ok_v_spamfilter_noham
,
1607 ok_v_spamfilter_nospam
,
1608 ok_v_spamfilter_rate
,
1609 ok_v_spamfilter_rate_scanscore
,
1610 ok_v_spamfilter_spam
,
1614 ok_v_ssl_cipher_list
,
1615 ok_v_ssl_config_file
,
1620 ok_b_ssl_no_default_ca
,
1627 ok_v_TERM
, /* {env=1} */
1628 ok_v_TMPDIR
, /* {vip=1,import=1,defval=VAL_TMPDIR} */
1630 ok_b_termcap_disable
,
1631 ok_v_toplines
, /* {notempty=1,num=1,defval="5"} */
1635 ok_v_USER
, /* {rdonly=1,import=1} */
1636 ok_v_umask
, /* {vip=1,nodel=1,posnum=1,i3val="0077"} */
1639 ok_v_VISUAL
, /* {env=1,defval=VAL_VISUAL} */
1641 ok_b_verbose
, /* {vip=1} */
1642 ok_v_version
, /* {virt=VERSION} */
1643 ok_v_version_major
, /* {virt=VERSION_MAJOR} */
1644 ok_v_version_minor
, /* {virt=VERSION_MINOR} */
1645 ok_v_version_update
, /* {virt=VERSION_UPDATE} */
1647 ok_b_writebackedited
1650 /* Locale-independent character classes */
1664 char *s
; /* the string's content */
1665 size_t l
; /* the stings's length */
1669 char *s_dat
; /*@ May contain NULs, not automatically terminated */
1670 ui32_t s_len
; /*@ gth of string */
1671 #ifdef HAVE_BYTE_ORDER_LITTLE
1672 ui32_t s_auto
: 1; /* Stored in auto-reclaimed storage? */
1674 ui32_t s_size
: 31; /* of .s_dat, -1 */
1675 #ifndef HAVE_BYTE_ORDER_LITTLE
1681 struct n_strlist
*sl_next
;
1683 char sl_dat
[VFIELD_SIZE(0)];
1685 #define n_STRLIST_MALLOC(SZ) /* XXX -> nailfuns.h (and pimp interface) */\
1686 smalloc(sizeof(struct n_strlist) - \
1687 VFIELD_SIZEOF(struct n_strlist, sl_dat) + (SZ) +1)
1690 struct str bi_start
; /* Start of (possibly) bidirectional text */
1691 struct str bi_end
; /* End of ... */
1692 size_t bi_pad
; /* No of visual columns to reserve for BIDI pad */
1695 struct n_cmd_arg_desc
{
1696 char cad_name
[12]; /* Name of command */
1697 ui32_t cad_no
; /* Number of entries in cad_ent_flags */
1698 /* [enum n_cmd_arg_desc_flags,arg-dep] */
1699 ui32_t cad_ent_flags
[VFIELD_SIZE(0)][2];
1701 /* ISO C(99) doesn't allow initialization of "flex array" */
1702 #define n_CMD_ARG_DESC_SUBCLASS_DEF(CMD,NO,VAR) \
1703 struct n_cmd_arg_desc_ ## CMD {\
1706 ui32_t cad_ent_flags[NO][2];\
1707 } const VAR = { #CMD, NO,
1708 #define n_CMD_ARG_DESC_SUBCLASS_DEF_END }
1709 #define n_CMD_ARG_DESC_SUBCLASS_CAST(P) ((struct n_cmd_arg_desc const*)P)
1711 struct n_cmd_arg_ctx
{
1712 struct n_cmd_arg_desc
const *cac_desc
;
1713 char const *cac_indat
; /* Input that shall be parsed */
1714 size_t cac_inlen
; /* Input length (UIZ_MAX: do a strlen()) */
1715 size_t cac_no
; /* Output: number of parsed arguments */
1716 struct n_cmd_arg
*cac_arg
; /* Output: parsed arguments */
1719 struct n_cmd_arg
{/* TODO incomplete, misses getmsglist() */
1720 struct n_cmd_arg
*ca_next
;
1721 char const *ca_indat
; /* Pointer into n_cmd_arg_ctx.cac_indat */
1722 size_t ca_inlen
; /* of .ca_indat of this arg (not terminated) */
1723 ui32_t ca_ent_flags
[2]; /* Copy of n_cmd_arg_desc.cad_ent_flags[X] */
1724 ui32_t ca_arg_flags
; /* [Output: _WYSH: copy of parse result flags] */
1727 struct str ca_str
; /* _STRING, _WYSH */
1728 } ca_arg
; /* Output: parsed result */
1732 struct n_colour_pen
;
1736 char const *url_input
; /* Input as given (really) */
1737 enum cproto url_cproto
; /* Communication protocol as given */
1738 bool_t url_needs_tls
; /* Wether the protocol uses SSL/TLS */
1739 bool_t url_had_user
; /* Wether .url_user was part of the URL */
1740 ui16_t url_portno
; /* atoi .url_port or default, host endian */
1741 char const *url_port
; /* Port (if given) or NULL */
1742 char url_proto
[14]; /* Communication protocol as 'xy\0//' */
1743 ui8_t url_proto_len
; /* Length of .url_proto ('\0' index) */
1744 ui8_t url_proto_xlen
; /* .. if '\0' is replaced with ':' */
1745 struct str url_user
; /* User, exactly as given / looked up */
1746 struct str url_user_enc
; /* User, urlxenc()oded */
1747 struct str url_pass
; /* Pass (urlxdec()oded) or NULL */
1748 struct str url_host
; /* Service hostname */
1749 struct str url_path
; /* Path suffix or NULL */
1750 /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1751 struct str url_h_p
; /* .url_host[:.url_port] */
1752 /* .url_user@.url_host
1753 * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1754 * *hostname*)! (And may later be overwritten according to *from*!) */
1756 struct str url_u_h_p
; /* .url_user@.url_host[:.url_port] */
1757 struct str url_eu_h_p
; /* .url_user_enc@.url_host[:.url_port] */
1758 char const *url_p_u_h_p
; /* .url_proto://.url_u_h_p */
1759 char const *url_p_eu_h_p
; /* .url_proto://.url_eu_h_p */
1760 char const *url_p_eu_h_p_p
; /* .url_proto://.url_eu_h_p[/.url_path] */
1764 enum cproto cc_cproto
; /* Communication protocol */
1765 enum authtype cc_authtype
; /* Desired authentication */
1766 char const *cc_auth
; /* Authentication type as string */
1767 struct str cc_user
; /* User (urlxdec()oded) or NULL */
1768 struct str cc_pass
; /* Password (urlxdec()oded) or NULL */
1772 struct n_dotlock_info
{
1773 char const *di_file_name
; /* Mailbox to lock */
1774 char const *di_lock_name
; /* .di_file_name + .lock */
1775 char const *di_hostname
; /* ..filled in parent (due resolver delays) */
1776 char const *di_randstr
; /* ..ditto, random string */
1777 size_t di_pollmsecs
; /* Delay in between locking attempts */
1778 struct stat
*di_stb
;
1782 /* Execution context bundles */
1785 void *l_smem
; /* salloc() memory TODO -> memraw? */
1786 /* TODO our new per-exec-ctx memory "allocators" are yet very dumb.
1787 * TODO for v15 those should not be wrapping nodes but real allocators */
1788 struct n_mem_raw
*l_memraw
; /* n_mem_alloc() (/ n_mem_free()) */
1789 struct n_mem_wrap
*l_memwrap
; /* n_mem_wrap() (/ n_mem_unwrap()) */
1793 struct n_mem_raw
*mr_prev
;
1794 struct n_mem_raw
*mr_next
;
1795 char mr_buf
[VFIELD_SIZE(0)];
1799 struct n_mem_wrap
*mw_prev
;
1800 struct n_mem_wrap
*mw_next
;
1802 void (*mw_dtor
)(void *obj
);
1805 struct mime_handler
{
1806 enum mime_handler_flags mh_flags
;
1807 struct str mh_msg
; /* Message describing this command */
1808 /* XXX union{} the following? */
1809 char const *mh_shell_cmd
; /* For MIME_HDL_CMD */
1810 int (*mh_ptf
)(void); /* PTF main() for MIME_HDL_PTF */
1814 FILE *qf_os
; /* Output stream */
1815 char const *qf_pfix
;
1816 ui32_t qf_pfix_len
; /* Length of prefix: 0: bypass */
1817 ui32_t qf_qfold_min
; /* Simple way: wrote prefix? */
1818 #ifdef HAVE_QUOTE_FOLD
1819 ui32_t qf_qfold_max
; /* Otherwise: line lengths */
1820 ui8_t qf_state
; /* *quote-fold* state machine */
1821 bool_t qf_brk_isws
; /* Breakpoint is at WS */
1823 ui32_t qf_wscnt
; /* Whitespace count */
1824 ui32_t qf_brkl
; /* Breakpoint */
1825 ui32_t qf_brkw
; /* Visual width, breakpoint */
1826 ui32_t qf_datw
; /* Current visual output line width */
1827 struct str qf_dat
; /* Current visual output line */
1828 struct str qf_currq
; /* Current quote, compressed */
1829 mbstate_t qf_mbps
[2];
1833 #ifdef HAVE_FILTER_HTML_TAGSOUP
1835 FILE *hf_os
; /* Output stream */
1837 ui32_t hf_lmax
; /* Maximum byte +1 in .hf_line/4 */
1838 ui32_t hf_len
; /* Current bytes in .hf_line */
1839 ui32_t hf_last_ws
; /* Last whitespace on line (fold purposes) */
1840 ui32_t hf_mboff
; /* Last offset for "mbtowc" */
1841 ui32_t hf_mbwidth
; /* We count characters not bytes if possible */
1842 char *hf_line
; /* Output line buffer - MUST be last field! */
1843 si32_t hf_href_dist
; /* Count of lines since last HREF flush */
1844 ui32_t hf_href_no
; /* HREF sequence number */
1845 struct htmlflt_href
*hf_hrefs
;
1846 struct htmlflt_tag
const *hf_ign_tag
; /* Tag that will end ignore mode */
1847 char *hf_curr
; /* Current cursor into .hf_bdat */
1848 char *hf_bmax
; /* Maximum byte in .hf_bdat +1 */
1849 char *hf_bdat
; /* (Temporary) Tag content data storage */
1853 struct search_expr
{
1854 char const *ss_where
; /* ..to search for the expr. (not always used) */
1855 char const *ss_sexpr
; /* String search expr.; NULL: use .ss_regex */
1861 /* This is somewhat temporary for pre v15 */
1863 ui32_t sm_flags
; /* enum n_sigman_flags */
1865 struct n_sigman
*sm_outer
;
1866 sighandler_type sm_ohup
;
1867 sighandler_type sm_oint
;
1868 sighandler_type sm_oquit
;
1869 sighandler_type sm_oterm
;
1870 sighandler_type sm_opipe
;
1874 struct termios_state
{
1875 struct termios ts_tios
;
1878 bool_t ts_needs_reset
;
1881 #define termios_state_reset() \
1883 if (termios_state.ts_needs_reset) {\
1884 tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1885 termios_state.ts_needs_reset = FAL0;\
1890 struct n_termcap_value
{
1891 enum n_termcap_captype tv_captype
;
1893 union n_termcap_value_data
{
1896 char const *tvd_string
;
1901 struct n_visual_info_ctx
{
1902 char const *vic_indat
; /*I Input data */
1903 size_t vic_inlen
; /*I If UIZ_MAX, strlen(.vic_indat) */
1904 char const *vic_oudat
; /*O remains */
1906 size_t vic_chars_seen
; /*O number of characters processed */
1907 size_t vic_bytes_seen
; /*O number of bytes passed */
1908 size_t vic_vi_width
; /*[O] visual width of the entire range */
1909 wc_t
*vic_woudat
; /*[O] if so requested */
1910 size_t vic_woulen
; /*[O] entries in .vic_woudat, if used */
1911 wc_t vic_waccu
; /*O The last wchar_t/char processed (if any) */
1912 enum n_visual_info_flags vic_flags
; /*O Copy of parse flags */
1914 #ifdef HAVE_C90AMEND1
1915 mbstate_t *vic_mbstate
; /*IO .vic_mbs_def used if NULL */
1916 mbstate_t vic_mbs_def
;
1920 struct time_current
{
1927 struct sock
{ /* data associated with a socket */
1928 int s_fd
; /* file descriptor */
1930 int s_use_ssl
; /* SSL is used */
1931 # ifdef HAVE_OPENSSL
1932 void *s_ssl
; /* SSL object */
1935 char *s_wbuf
; /* for buffered writes */
1936 int s_wbufsize
; /* allocated size of s_buf */
1937 int s_wbufpos
; /* position of first empty data byte */
1938 char *s_rbufptr
; /* read pointer to s_rbuf */
1939 int s_rsz
; /* size of last read in s_rbuf */
1940 char const *s_desc
; /* description of error messages */
1941 void (*s_onclose
)(void); /* execute on close */
1942 char s_rbuf
[LINESIZE
+ 1]; /* for buffered reads */
1947 struct ccred sc_cred
;
1948 struct sock sc_sock
;
1953 MB_NONE
= 000, /* no reply expected */
1954 MB_COMD
= 001, /* command reply expected */
1955 MB_MULT
= 002, /* multiline reply expected */
1956 MB_PREAUTH
= 004, /* not in authenticated state */
1957 MB_BYE
= 010 /* may accept a BYE state */
1959 FILE *mb_itf
; /* temp file with messages, read open */
1960 FILE *mb_otf
; /* same, write open */
1961 char *mb_sorted
; /* sort method */
1963 MB_VOID
, /* no type (e. g. connection failed) */
1964 MB_FILE
, /* local file */
1965 MB_POP3
, /* POP3 mailbox */
1966 MB_MAILDIR
/* maildir folder */
1967 } mb_type
; /* type of mailbox */
1969 MB_DELE
= 01, /* may delete messages in mailbox */
1970 MB_EDIT
= 02 /* may edit messages in mailbox */
1972 int mb_threaded
; /* mailbox has been threaded */
1973 struct sock mb_sock
; /* socket structure */
1977 NEED_UNSPEC
, /* unspecified need, don't fetch */
1978 NEED_HEADER
, /* need the header of a message */
1979 NEED_BODY
/* need header and body of a message */
1983 HAVE_NOTHING
, /* nothing downloaded yet */
1984 HAVE_HEADER
= 01, /* header is downloaded */
1985 HAVE_BODY
= 02 /* entire message is downloaded */
1988 /* flag bits. Attention: Flags that are used in cache.c may not change */
1990 MUSED
= (1<< 0), /* entry is used, but this bit isn't */
1991 MDELETED
= (1<< 1), /* entry has been deleted */
1992 MSAVED
= (1<< 2), /* entry has been saved */
1993 MTOUCH
= (1<< 3), /* entry has been noticed */
1994 MPRESERVE
= (1<< 4), /* keep entry in sys mailbox */
1995 MMARK
= (1<< 5), /* message is marked! */
1996 MODIFY
= (1<< 6), /* message has been modified */
1997 MNEW
= (1<< 7), /* message has never been seen */
1998 MREAD
= (1<< 8), /* message has been read sometime. */
1999 MSTATUS
= (1<< 9), /* message status has changed */
2000 MBOX
= (1<<10), /* Send this to mbox, regardless */
2001 MNOFROM
= (1<<11), /* no From line */
2002 MHIDDEN
= (1<<12), /* message is hidden to user */
2003 MBOXED
= (1<<13), /* message has been sent to mbox */
2004 MNEWEST
= (1<<14), /* message is very new (newmail) */
2005 MFLAG
= (1<<15), /* message has been flagged recently */
2006 MUNFLAG
= (1<<16), /* message has been unflagged */
2007 MFLAGGED
= (1<<17), /* message is `flagged' */
2008 MANSWER
= (1<<18), /* message has been answered recently */
2009 MUNANSWER
= (1<<19), /* message has been unanswered */
2010 MANSWERED
= (1<<20), /* message is `answered' */
2011 MDRAFT
= (1<<21), /* message has been drafted recently */
2012 MUNDRAFT
= (1<<22), /* message has been undrafted */
2013 MDRAFTED
= (1<<23), /* message is marked as `draft' */
2014 MOLDMARK
= (1<<24), /* messages was marked previously */
2015 MSPAM
= (1<<25), /* message is classified as spam */
2016 MSPAMUNSURE
= (1<<26) /* message may be spam, but it is unsure */
2018 #define MMNORM (MDELETED | MSAVED | MHIDDEN)
2019 #define MMNDEL (MDELETED | MHIDDEN)
2021 #define visible(mp) (((mp)->m_flag & MMNDEL) == 0)
2024 enum mflag m_flag
; /* flags */
2025 enum havespec m_have
; /* downloaded parts of the part */
2027 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2029 int m_block
; /* block number of this part */
2030 size_t m_offset
; /* offset in block of part */
2031 size_t m_size
; /* Bytes in the part */
2032 size_t m_xsize
; /* Bytes in the full part */
2033 long m_lines
; /* Lines in the message */
2034 long m_xlines
; /* Lines in the full message */
2035 time_t m_time
; /* time the message was sent */
2036 char const *m_from
; /* message sender */
2037 struct mimepart
*m_nextpart
; /* next part at same level */
2038 struct mimepart
*m_multipart
; /* parts of multipart */
2039 struct mimepart
*m_parent
; /* enclosing multipart part */
2040 char const *m_ct_type
; /* content-type */
2041 char const *m_ct_type_plain
; /* content-type without specs */
2042 char const *m_ct_type_usr_ovwr
; /* Forcefully overwritten one */
2043 enum mimecontent m_mimecontent
; /* same in enum */
2044 char const *m_charset
; /* charset */
2045 char const *m_ct_enc
; /* content-transfer-encoding */
2046 enum mime_enc m_mime_enc
; /* same in enum */
2047 char *m_partstring
; /* part level string */
2048 char *m_filename
; /* attachment filename */
2052 enum mflag m_flag
; /* flags */
2053 enum havespec m_have
; /* downloaded parts of the message */
2055 ui32_t m_spamscore
; /* Spam score as int, 24:8 bits */
2057 int m_block
; /* block number of this message */
2058 size_t m_offset
; /* offset in block of message */
2059 size_t m_size
; /* Bytes in the message */
2060 size_t m_xsize
; /* Bytes in the full message */
2061 long m_lines
; /* Lines in the message */
2062 long m_xlines
; /* Lines in the full message */
2063 time_t m_time
; /* time the message was sent */
2064 time_t m_date
; /* time in the 'Date' field */
2065 unsigned m_idhash
; /* hash on Message-ID for threads */
2066 struct message
*m_child
; /* first child of this message */
2067 struct message
*m_younger
; /* younger brother of this message */
2068 struct message
*m_elder
; /* elder brother of this message */
2069 struct message
*m_parent
; /* parent of this message */
2070 unsigned m_level
; /* thread level of message */
2071 long m_threadpos
; /* position in threaded display */
2072 char *m_maildir_file
; /* original maildir file of msg */
2073 ui32_t m_maildir_hash
; /* hash of file name in maildir sub */
2074 int m_collapsed
; /* collapsed thread information */
2077 /* Given a file address, determine the block number it represents */
2078 #define mailx_blockof(off) ((int) ((off) / 4096))
2079 #define mailx_offsetof(off) ((int) ((off) % 4096))
2080 #define mailx_positionof(block, offset) ((off_t)(block) * 4096 + (offset))
2082 /* Argument types */
2084 ARG_MSGLIST
= 0, /* Message list type */
2085 ARG_STRLIST
= 1, /* A pure string */
2086 ARG_RAWLIST
= 2, /* getrawlist(), old style */
2087 ARG_NOLIST
= 3, /* Just plain 0 */
2088 ARG_NDMLIST
= 4, /* Message list, no defaults */
2089 ARG_WYSHLIST
= 5, /* getrawlist(), sh(1) compatible */
2090 ARG_WYRALIST
= 6, /* _RAWLIST or _WYSHLIST (with `wysh') */
2091 ARG_ARGMASK
= 7, /* Mask of the above */
2093 ARG_A
= 1u<< 4, /* Needs an active mailbox */
2094 ARG_F
= 1u<< 5, /* Is a conditional command */
2095 ARG_H
= 1u<< 6, /* Never place in history */
2096 ARG_I
= 1u<< 7, /* Interactive command bit */
2097 ARG_M
= 1u<< 8, /* Legal from send mode bit */
2098 ARG_P
= 1u<< 9, /* Autoprint dot after command */
2099 ARG_R
= 1u<<10, /* Cannot be called from collect / recursion */
2100 ARG_S
= 1u<<11, /* Cannot be called unless PS_STARTED (POSIX) */
2101 ARG_T
= 1u<<12, /* Is a transparent command */
2102 ARG_V
= 1u<<13, /* Places data in temporary_arg_v_store */
2103 ARG_W
= 1u<<14, /* Invalid when read only bit */
2104 ARG_O
= 1u<<15 /* OBSOLETE()d command */
2108 GTO
= 1<< 0, /* Grab To: line */
2109 GSUBJECT
= 1<< 1, /* Likewise, Subject: line */
2110 GCC
= 1<< 2, /* And the Cc: line */
2111 GBCC
= 1<< 3, /* And also the Bcc: line */
2113 GNL
= 1<< 4, /* Print blank line after */
2114 GDEL
= 1<< 5, /* Entity removed from list */
2115 GCOMMA
= 1<< 6, /* detract() puts in commas */
2116 GUA
= 1<< 7, /* User-Agent field */
2117 GMIME
= 1<< 8, /* MIME 1.0 fields */
2118 GMSGID
= 1<< 9, /* a Message-ID */
2119 GNAMEONLY
= 1<<10, /* detract() does NOT use fullnames */
2121 GIDENT
= 1<<11, /* From:, Reply-To:, MFT: (user headers) */
2122 GREF
= 1<<12, /* References:, In-Reply-To:, (Message-ID:) */
2123 GDATE
= 1<<13, /* Date: field */
2124 GFULL
= 1<<14, /* Include full names, comments etc. */
2125 GSKIN
= 1<<15, /* Skin names */
2126 GEXTRA
= 1<<16, /* Extra fields (mostly like GIDENT XXX) */
2127 GFILES
= 1<<17, /* Include filename and pipe addresses */
2128 GFULLEXTRA
= 1<<18 /* Only with GFULL: GFULL less address */
2130 #define GMASK (GTO | GSUBJECT | GCC | GBCC)
2134 HF_LIST_REPLY
= 1<< 0,
2135 HF_MFT_SENDER
= 1<< 1, /* Add ourselves to Mail-Followup-To: */
2136 HF_RECIPIENT_RECORD
= 1<<10, /* Save message in file named after rec. */
2140 /* Structure used to pass about the current state of a message (header) */
2141 struct n_header_field
{
2142 struct n_header_field
*hf_next
;
2143 ui32_t hf_nl
; /* Field-name length */
2144 ui32_t hf_bl
; /* Field-body length*/
2145 char hf_dat
[VFIELD_SIZE(0)];
2149 ui32_t h_flags
; /* enum header_flags bits */
2151 struct name
*h_to
; /* Dynamic "To:" string */
2152 char *h_subject
; /* Subject string */
2153 struct name
*h_cc
; /* Carbon copies string */
2154 struct name
*h_bcc
; /* Blind carbon copies */
2155 struct name
*h_ref
; /* References (possibly overridden) */
2156 struct attachment
*h_attach
; /* MIME attachments */
2157 char *h_charset
; /* preferred charset */
2158 struct name
*h_from
; /* overridden "From:" field */
2159 struct name
*h_sender
; /* overridden "Sender:" field */
2160 struct name
*h_replyto
; /* overridden "Reply-To:" field */
2161 struct name
*h_message_id
; /* overridden "Message-ID:" field */
2162 struct name
*h_in_reply_to
;/* overridden "In-Reply-To:" field */
2163 struct name
*h_mft
; /* Mail-Followup-To */
2164 char const *h_list_post
; /* Address from List-Post:, for `Lreply' */
2165 struct n_header_field
*h_user_headers
;
2166 struct n_header_field
*h_custom_headers
; /* (Cached result) */
2169 /* Handling of namelist nodes used in processing the recipients of mail and
2170 * aliases, inspection of mail-addresses and all that kind of stuff */
2172 NAME_NAME_SALLOC
= 1<< 0, /* .n_name is doped */
2173 NAME_FULLNAME_SALLOC
= 1<< 1, /* .n_fullname is doped */
2174 NAME_SKINNED
= 1<< 2, /* Is actually skin()ned */
2175 NAME_IDNA
= 1<< 3, /* IDNA was applied */
2177 NAME_ADDRSPEC_CHECKED
= 1<< 4, /* Address has been .. and */
2178 NAME_ADDRSPEC_ISFILE
= 1<< 5, /* ..is a file path */
2179 NAME_ADDRSPEC_ISPIPE
= 1<< 6, /* ..is a command for piping */
2180 NAME_ADDRSPEC_ISFILEORPIPE
= NAME_ADDRSPEC_ISFILE
| NAME_ADDRSPEC_ISPIPE
,
2181 NAME_ADDRSPEC_ISNAME
= 1<< 7, /* ..is a valid mail network address */
2182 NAME_ADDRSPEC_ISADDR
= 1<< 8, /* ..is a valid mail network address */
2184 NAME_ADDRSPEC_ERR_EMPTY
= 1<< 9, /* An empty string (or NULL) */
2185 NAME_ADDRSPEC_ERR_ATSEQ
= 1<<10, /* Weird @ sequence */
2186 NAME_ADDRSPEC_ERR_CHAR
= 1<<11, /* Invalid character */
2187 NAME_ADDRSPEC_ERR_IDNA
= 1<<12, /* IDNA convertion failed */
2188 NAME_ADDRSPEC_INVALID
= NAME_ADDRSPEC_ERR_EMPTY
|
2189 NAME_ADDRSPEC_ERR_ATSEQ
| NAME_ADDRSPEC_ERR_CHAR
|
2190 NAME_ADDRSPEC_ERR_IDNA
,
2192 /* Error storage (we must fit in 31-bit) */
2194 _NAME_MAXWC
= 0x3FFFF,
2195 _NAME_MASKWC
= _NAME_MAXWC
<< _NAME_SHIFTWC
2198 /* In the !_ERR_EMPTY case, the failing character can be queried */
2199 #define NAME_ADDRSPEC_ERR_GETWC(F) \
2200 ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2201 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2203 (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2204 (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2208 struct name
*n_flink
; /* Forward link in list. */
2209 struct name
*n_blink
; /* Backward list link */
2210 enum gfield n_type
; /* From which list it came */
2211 enum nameflags n_flags
; /* enum nameflags */
2212 char *n_name
; /* This fella's address */
2213 char *n_fullname
; /* Ditto, unless GFULL including comment */
2214 char *n_fullextra
; /* GFULL, without address */
2218 char const *ag_input
; /* Input string as given */
2219 size_t ag_ilen
; /* strlen() of input */
2220 size_t ag_iaddr_start
; /* Start of *addr-spec* in .ag_input */
2221 size_t ag_iaddr_aend
; /* ..and one past its end */
2222 char *ag_skinned
; /* Output (alloced if !=.ag_input) */
2223 size_t ag_slen
; /* strlen() of .ag_skinned */
2224 size_t ag_sdom_start
; /* Start of domain in .ag_skinned, */
2225 enum nameflags ag_n_flags
; /* enum nameflags of .ag_skinned */
2228 /* MIME attachments */
2230 AC_DEFAULT
, /* _get_lc() -> _iter_*() */
2231 AC_FIX_OUTCS
, /* _get_lc() -> "charset=" .a_charset */
2232 AC_FIX_INCS
, /* "charset=".a_input_charset (nocnv) */
2233 AC_TMPFILE
/* attachment.a_tmpf is converted */
2237 struct attachment
*a_flink
; /* Forward link in list. */
2238 struct attachment
*a_blink
; /* Backward list link */
2239 char const *a_name
; /* file name */
2240 char const *a_content_type
; /* content type */
2241 char const *a_content_disposition
; /* content disposition */
2242 char const *a_content_id
; /* content id */
2243 char const *a_content_description
; /* content description */
2244 char const *a_input_charset
; /* Interpretation depends on .a_conv */
2245 char const *a_charset
; /* ... */
2246 FILE *a_tmpf
; /* If AC_TMPFILE */
2247 enum attach_conv a_conv
; /* User chosen conversion */
2248 int a_msgno
; /* message number */
2252 struct header
*sb_hp
;
2255 struct str sb_signer
; /* USER@HOST for signing+ */
2257 struct ccred sb_ccred
;
2260 /* Structure of the hash table of ignored header fields */
2263 bool_t it_auto
; /* Stored in auto-reclaimed storage? */
2265 struct n_ignoretab_field
{
2266 struct n_ignoretab_field
*itf_next
;
2267 char itf_field
[VFIELD_SIZE(0)]; /* Header field */
2268 } *it_head
[5 /* TODO make dynamic hashmap */];
2271 /* For saving the current directory and later returning */
2276 char cw_wd
[PATH_MAX
];
2281 * Global variable declarations
2283 * These become instantiated in main.c.
2287 #ifdef n_MAIN_SOURCE
2288 # ifndef HAVE_AMALGAMATION
2297 VL
int mb_cur_max
; /* Value of MB_CUR_MAX */
2298 VL
int realscreenheight
; /* The real screen height */
2299 VL
int scrnwidth
; /* Screen width, or best guess */
2300 VL
int scrnheight
; /* Screen height/guess (4 header) */
2302 VL
char const *myname
; /* My login name */
2303 VL
char const *progname
; /* Our name */
2304 VL
char const *tempdir
; /* The temporary directory */
2306 VL gid_t group_id
; /* getgid() and getuid() */
2309 VL
int exit_status
; /* Exit status */
2310 VL ui32_t options
; /* Bits of enum user_options */
2311 VL
char const *option_Mm_arg
; /* Argument for -[Mm] aka OPT_[Mm]_FLAG */
2312 VL
struct name
*option_r_arg
; /* Argument to -r option */
2313 VL
char const **smopts
; /* sendmail(1) opts from commline */
2314 VL
size_t smopts_cnt
; /* Entries in smopts */
2316 VL ui32_t pstate
; /* Bits of enum program_state */
2317 VL
size_t noreset
; /* String resets suspended (recursive) */
2319 /* XXX stylish sorting */
2320 VL
int msgCount
; /* Count of messages read in */
2321 VL
struct mailbox mb
; /* Current mailbox */
2322 VL
int image
; /* File descriptor for msg image */
2323 VL
char mailname
[PATH_MAX
]; /* Name of current file TODO URL/object*/
2324 VL
char displayname
[80 - 40]; /* Prettyfied for display TODO URL/obj*/
2325 VL
char prevfile
[PATH_MAX
]; /* Name of previous file TODO URL/obj */
2326 VL
char const *account_name
; /* Current account name or NULL */
2327 VL off_t mailsize
; /* Size of system mailbox */
2328 VL
struct message
*dot
; /* Pointer to current message */
2329 VL
struct message
*prevdot
; /* Previous current message */
2330 VL
struct message
*message
; /* The actual message structure */
2331 VL
struct message
*threadroot
; /* first threaded message */
2332 VL
int *n_msgvec
; /* Folder setmsize(), list.c res. store*/
2334 VL
struct ignoretab ignore
[2]; /* ignored and retained fields
2335 * 0 is ignore, 1 is retain */
2336 VL
struct ignoretab saveignore
[2]; /* ignored and retained fields
2337 * on save to folder */
2338 VL
struct ignoretab fwdignore
[2]; /* fields to ignore for forwarding */
2339 #define allignore ((struct ignoretab*)-2) /* special, ignore all headers */
2341 VL
struct time_current time_current
; /* time(3); send: mail1() XXXcarrier */
2342 VL
struct termios_state termios_state
; /* getpassword(); see commands().. */
2345 VL
enum ssl_verify_level ssl_verify_level
; /* SSL verification level */
2352 VL sigjmp_buf srbuf
;
2354 VL sighandler_type dflpipe
;
2356 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
2357 * TODO carrier structs instead of locals */
2358 VL
char *temporary_arg_v_store
;
2359 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
2360 VL
char const *temporary_protocol_ext
;
2362 /* The remaining variables need initialization */
2364 #ifndef HAVE_AMALGAMATION
2365 VL
char const month_names
[12 + 1][4];
2366 VL
char const weekday_names
[7 + 1][4];
2368 VL
char const uagent
[sizeof UAGENT
];
2370 VL ui16_t
const class_char
[1 + 0x7F];
2374 * Finally, let's include the function prototypes XXX embed
2377 #ifndef n_PRIVSEP_SOURCE
2378 # include "nailfuns.h"