nail.h

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ Header inclusion, macros, constants, types and the global var declarations.
   3  *
   4  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   5  * Copyright (c) 2012 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
   6  */
   7 /*
   8  * Copyright (c) 1980, 1993
   9  *      The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  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.
  22  *
  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
  33  * SUCH DAMAGE.
  34  */
  35
  36 /*
  37  * Mail -- a mail program
  38  *
  39  * Author: Kurt Shoens (UCB) March 25, 1978
  40  */
  41
  42 #include "config.h"
  43
  44 #include <sys/stat.h>
  45 #include <sys/types.h>
  46
  47 #ifdef HAVE_GETTIMEOFDAY
  48 # include <sys/time.h>
  49 #endif
  50
  51 #include <errno.h>
  52 #include <fcntl.h>
  53 #include <limits.h>
  54 #include <setjmp.h>
  55 #include <signal.h>
  56 #include <stdarg.h>
  57 #include <stdio.h>
  58 #include <stdlib.h>
  59 #include <string.h>
  60 #include <termios.h>
  61 #include <time.h>
  62 #include <unistd.h>
  63
  64 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
  65 # include <stdint.h>
  66 #else
  67 # include <inttypes.h>
  68 #endif
  69
  70 #ifdef HAVE_C90AMEND1
  71 # include <wchar.h>
  72 # include <wctype.h>
  73 #endif
  74 #ifdef HAVE_DEBUG
  75 # include <assert.h>
  76 #endif
  77 #ifdef HAVE_ICONV
  78 # include <iconv.h>
  79 #endif
  80 #ifdef HAVE_REGEX
  81 # include <regex.h>
  82 #endif
  83
  84 #ifdef HAVE_OPENSSL_MD5
  85 # include <openssl/md5.h>
  86 #endif
  87
  88 /*
  89  * Constants, some nail-specific macros
  90  */
  91
  92 #if !defined NI_MAXHOST
  93 # define NI_MAXHOST     1025
  94 #endif
  95
  96 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
  97 #ifndef PATH_MAX
  98 # ifdef MAXPATHLEN
  99 #  define PATH_MAX      MAXPATHLEN
 100 # else
 101 #  define PATH_MAX      1024        /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
 102 # endif
 103 #endif
 104
 105 #ifndef HOST_NAME_MAX
 106 # ifdef _POSIX_HOST_NAME_MAX
 107 #  define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
 108 # else
 109 #  define HOST_NAME_MAX 255
 110 # endif
 111 #endif
 112
 113 #ifndef NAME_MAX
 114 # ifdef _POSIX_NAME_MAX
 115 #  define NAME_MAX      _POSIX_NAME_MAX
 116 # else
 117 #  define NAME_MAX      14
 118 # endif
 119 #endif
 120 #if NAME_MAX < 8
 121 # error NAME_MAX too small
 122 #endif
 123
 124 #ifndef STDIN_FILENO
 125 # define STDIN_FILENO   0
 126 #endif
 127 #ifndef STDOUT_FILENO
 128 # define STDOUT_FILENO  1
 129 #endif
 130 #ifndef STDERR_FILENO
 131 # define STDERR_FILENO  2
 132 #endif
 133
 134 #ifdef NSIG_MAX
 135 # undef NSIG
 136 # define NSIG           NSIG_MAX
 137 #elif !defined NSIG
 138 # define NSIG           ((sizeof(sigset_t) * 8) - 1)
 139 #endif
 140
 141 #ifdef O_CLOEXEC
 142 # define _O_CLOEXEC        O_CLOEXEC
 143 # define _CLOEXEC_SET(FD)  do {;} while(0)
 144 #else
 145 # define _O_CLOEXEC        0
 146 # define _CLOEXEC_SET(FD)  \
 147    do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
 148 #endif
 149
 150 /*  */
 151
 152 #if BUFSIZ + 0 > 2560               /* TODO simply use BUFSIZ? */
 153 # define LINESIZE       BUFSIZ      /* max readable line width */
 154 #else
 155 # define LINESIZE       2560
 156 #endif
 157 #define BUFFER_SIZE     (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
 158
 159 /* Network protocol newline */
 160 #define NETNL           "\015\012"
 161 #define NETLINE(X)      X NETNL
 162
 163 /* Number of Not-Yet-Dead calls that are remembered */
 164 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
 165 # ifdef HAVE_NYD2
 166 #  define NYD_CALLS_MAX (25 * 84)
 167 # elif defined HAVE_DEVEL
 168 #  define NYD_CALLS_MAX (25 * 42)
 169 # else
 170 #  define NYD_CALLS_MAX (25 * 10)
 171 # endif
 172 #endif
 173
 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 n_file_lock() fails */
 178 #define ERRORS_MAX      1000     /* Maximum error ring entries TODO configable*/
 179 #define ESCAPE          '~'      /* Default escape for sending */
 180 #define HIST_SIZE       242      /* tty.c: history list default size */
 181 #define HSHSIZE         23       /* Hash prime TODO make dynamic, obsolete */
 182 #define MAXARGC         1024     /* Maximum list of raw strings */
 183 #define MAXEXP          25       /* Maximum expansion of aliases */
 184 #define PROMPT_BUFFER_SIZE 80    /* getprompt() bufsize (> 3!) */
 185 #define REFERENCES_MAX  20       /* Maximum entries in References: */
 186 #define FTMP_OPEN_TRIES 10       /* Maximum number of Ftmp() open(2) tries */
 187
 188 #define ACCOUNT_NULL    "null"   /* Name of "null" account */
 189 #define MAILRC          "~/.mailrc"
 190 #define NETRC           "~/.netrc"
 191 #define TMPDIR_FALLBACK "/tmp"
 192
 193 /* Some environment variables for pipe hooks */
 194 #define AGENT_USER      "NAIL_USER"
 195 #define AGENT_USER_ENC  "NAIL_USER_ENC"
 196 #define AGENT_HOST      "NAIL_HOST"
 197 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
 198
 199 /* Colour stuff */
 200 #ifdef HAVE_COLOUR
 201 # define n_COLOUR(X)       X
 202 #else
 203 # define n_COLOUR(X)
 204 #endif
 205
 206 /* Special FD requests for run_command() / start_command() */
 207 #define COMMAND_FD_PASS -1
 208 #define COMMAND_FD_NULL -2
 209
 210 /*  */
 211 #define FROM_DATEBUF    64    /* Size of RFC 4155 From_ line date */
 212 #define DATE_DAYSYEAR   365L
 213 #define DATE_SECSMIN    60L
 214 #define DATE_MINSHOUR   60L
 215 #define DATE_HOURSDAY   24L
 216 #define DATE_SECSDAY    (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
 217
 218 /* *indentprefix* default as of POSIX */
 219 #define INDENT_DEFAULT  "\t"
 220
 221 /* Default *encoding* as enum mime_enc below */
 222 #define MIME_DEFAULT_ENCODING MIMEE_QP
 223
 224 /* Maximum allowed line length in a mail before QP folding is necessary), and
 225  * the real limit we go for */
 226 #define MIME_LINELEN_MAX   998   /* Plus CRLF */
 227 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
 228
 229 /* Ditto, SHOULD */
 230 #define MIME_LINELEN    78    /* Plus CRLF */
 231
 232 /* And in headers which contain an encoded word according to RFC 2047 there is
 233  * yet another limit; also RFC 2045: 6.7, (5). */
 234 #define MIME_LINELEN_RFC2047 76
 235
 236 /* Locations of mime.types(5) */
 237 #define MIME_TYPES_USR  "~/.mime.types"
 238 #define MIME_TYPES_SYS  "/etc/mime.types"
 239
 240 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set.
 241  * (Keep in SYNC: ./nail.1:"Character sets", ./nail.h:CHARSET_*!) */
 242 #define CHARSET_7BIT    "US-ASCII"
 243 #ifdef HAVE_ICONV
 244 # define CHARSET_8BIT      "UTF-8"
 245 # define CHARSET_8BIT_OKEY charset_8bit
 246 #else
 247 # define CHARSET_8BIT      "ISO-8859-1"
 248 # define CHARSET_8BIT_OKEY ttycharset
 249 #endif
 250
 251 /* Some environment variables for pipe hooks etc. */
 252 #define NAILENV_TMPDIR              "NAIL_TMPDIR"
 253 #define NAILENV_FILENAME            "NAIL_FILENAME"
 254 #define NAILENV_FILENAME_GENERATED  "NAIL_FILENAME_GENERATED"
 255 #define NAILENV_FILENAME_TEMPORARY  "NAIL_FILENAME_TEMPORARY"
 256 #define NAILENV_CONTENT             "NAIL_CONTENT"
 257 #define NAILENV_CONTENT_EVIDENCE    "NAIL_CONTENT_EVIDENCE"
 258
 259 /* Is *W* a quoting (ASCII only) character? */
 260 #define ISQUOTE(W)      \
 261    ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
 262
 263 /* Maximum number of quote characters (not bytes!) that'll be used on
 264  * follow lines when compressing leading quote characters */
 265 #define QUOTE_MAX       42
 266
 267 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
 268 #define QUOTE_TAB_SPACES 8
 269
 270 /* Maximum size of a message that is passed through to the spam system */
 271 #define SPAM_MAXSIZE    420000
 272
 273 /* String dope: dynamic buffer size, and size of the single builtin one that's
 274  * used first; note that these value include the size of the structure */
 275 #define SBUFFER_SIZE    ((0x10000u >> 1u) - 0x400)
 276 #define SBUFFER_BUILTIN (0x10000u >> 1u)
 277
 278 /* Switch indicating necessity of terminal access interface (termcap.c) */
 279 #if defined HAVE_TERMCAP || defined HAVE_COLOUR || defined HAVE_MLE
 280 # define n_HAVE_TCAP
 281 #endif
 282
 283 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
 284 #ifndef XSHELL
 285 # define XSHELL         "/bin/sh"
 286 #endif
 287 #ifndef XLISTER
 288 # define XLISTER        "ls"
 289 #endif
 290 #ifndef XPAGER
 291 # define XPAGER         "more"
 292 #endif
 293
 294 /*
 295  * OS, CC support, generic macros etc.
 296  */
 297
 298 /* OS: we're not a library, only set what needs special treatment somewhere */
 299 #define OS_DRAGONFLY    0
 300 #define OS_SOLARIS      0
 301 #define OS_SUNOS        0
 302
 303 #ifdef __DragonFly__
 304 # undef OS_DRAGONFLY
 305 # define OS_DRAGONFLY   1
 306 #elif defined __solaris__ || defined __sun
 307 # if defined __SVR4 || defined __svr4__
 308 #  undef OS_SOLARIS
 309 #  define OS_SOLARIS    1
 310 # else
 311 #  undef OS_SUNOS
 312 #  define OS_SUNOS      1
 313 # endif
 314 #endif
 315
 316 /* CC */
 317 #define CC_CLANG           0
 318 #define PREREQ_CLANG(X,Y)  0
 319 #define CC_GCC             0
 320 #define PREREQ_GCC(X,Y)    0
 321 #define CC_TCC             0
 322 #define PREREQ_TCC(X,Y)    0
 323
 324 #ifdef __clang__
 325 # undef CC_CLANG
 326 # undef PREREQ_CLANG
 327 # define CC_CLANG          1
 328 # define PREREQ_CLANG(X,Y) \
 329    (__clang_major__ + 0 > (X) || \
 330     (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
 331 # define __EXTEN           __extension__
 332
 333 #elif defined __GNUC__
 334 # undef CC_GCC
 335 # undef PREREQ_GCC
 336 # define CC_GCC            1
 337 # define PREREQ_GCC(X,Y)   \
 338    (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
 339 # define __EXTEN           __extension__
 340
 341 #elif defined __TINYC__
 342 # undef CC_TCC
 343 # define CC_TCC            1
 344 #endif
 345
 346 #ifndef __EXTEN
 347 # define __EXTEN
 348 #endif
 349
 350 /* Suppress some technical warnings via #pragma's unless developing.
 351  * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
 352 #ifndef HAVE_DEVEL
 353 # if PREREQ_CLANG(3, 4)
 354 #  pragma clang diagnostic ignored "-Wunused-result"
 355 #  pragma clang diagnostic ignored "-Wformat"
 356 # elif PREREQ_GCC(4, 7)
 357 #  pragma GCC diagnostic ignored "-Wunused-local-typedefs"
 358 #  pragma GCC diagnostic ignored "-Wunused-result"
 359 #  pragma GCC diagnostic ignored "-Wformat"
 360 # endif
 361 #endif
 362
 363 /* For injection macros like DBG(), NATCH_CHAR() */
 364 #define COMMA           ,
 365
 366 #define EMPTY_FILE()    typedef int CONCAT(avoid_empty_file__, n_FILE);
 367
 368 /* Pointer to size_t */
 369 #define PTR2SIZE(X)     ((size_t)(uintptr_t)(X))
 370
 371 /* Pointer comparison (types from below) */
 372 #define PTRCMP(A,C,B)   ((uintptr_t)(A) C (uintptr_t)(B))
 373
 374 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
 375  * Note: doesn't sign-extend correctly, that's still up to the caller */
 376 #define UICMP(T,A,C,B)  ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
 377
 378 /* Align something to a size/boundary that cannot cause just any problem */
 379 #define n_ALIGN(X)      (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
 380
 381 /* Members in constant array */
 382 #ifndef NELEM
 383 # define NELEM(A)       (sizeof(A) / sizeof(A[0]))
 384 #endif
 385
 386 /* sizeof() for member fields */
 387 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
 388
 389 /* Casts-away (*NOT* cast-away) */
 390 #define UNUSED(X)       ((void)(X))
 391 #define UNCONST(P)      ((void*)(uintptr_t)(void const*)(P))
 392 #define UNVOLATILE(P)   ((void*)(uintptr_t)(void volatile*)(P))
 393 #define UNXXX(T,C,P)    ((T)(uintptr_t)(C)(P))
 394
 395 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
 396 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
 397 # define STRING(X)      #X
 398 # define XSTRING(X)     STRING(X)
 399 # define CONCAT(S1,S2)  _CONCAT(S1, S2)
 400 # define _CONCAT(S1,S2) S1 ## S2
 401 #else
 402 # define STRING(X)      "X"
 403 # define XSTRING        STRING
 404 # define CONCAT(S1,S2)  S1/**/S2
 405 #endif
 406
 407 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 408 # define n_FIELD_INITN(N) CONCAT(., N) =
 409 # define n_FIELD_INITI(I) [I] =
 410 #else
 411 # define n_FIELD_INITN(N)
 412 # define n_FIELD_INITI(N)
 413 #endif
 414
 415 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 416 # define VFIELD_SIZE(X)
 417 # define VFIELD_SIZEOF(T,F) (0)
 418 # define VSTRUCT_SIZEOF(T,F) sizeof(T)
 419 #else
 420 # define VFIELD_SIZE(X) \
 421   ((X) == 0 ? sizeof(size_t) \
 422    : ((ssize_t)(X) < 0 ? sizeof(size_t) - ABS(X) : (size_t)(X)))
 423 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
 424 # define VSTRUCT_SIZEOF(T,F) (sizeof(T) - SIZEOF_FIELD(T, F))
 425 #endif
 426
 427 #ifdef HAVE_INLINE
 428 # define SINLINE        n_INLINE /* TODO obsolete */
 429 #else
 430 # define SINLINE        static
 431 #endif
 432
 433 #undef __FUN__
 434 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 435 # define __FUN__        __func__
 436 #elif CC_CLANG || PREREQ_GCC(3, 4)
 437 # define __FUN__        __extension__ __FUNCTION__
 438 #else
 439 # define __FUN__        uagent   /* Something that is not a literal */
 440 #endif
 441
 442 #if defined __predict_true && defined __predict_false
 443 # define LIKELY(X)      __predict_true(X)
 444 # define UNLIKELY(X)    __predict_false(X)
 445 #elif CC_CLANG || PREREQ_GCC(2, 96)
 446 # define LIKELY(X)      __builtin_expect(X, 1)
 447 # define UNLIKELY(X)    __builtin_expect(X, 0)
 448 #else
 449 # define LIKELY(X)      (X)
 450 # define UNLIKELY(X)    (X)
 451 #endif
 452
 453 #undef HAVE_NATCH_CHAR
 454 #undef NATCH_CHAR
 455 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
 456 # define HAVE_NATCH_CHAR
 457 # define NATCH_CHAR(X)  X
 458 #else
 459 # define NATCH_CHAR(X)
 460 #endif
 461
 462 /* Compile-Time-Assert
 463  * Problem is that some compilers warn on unused local typedefs, so add
 464  * a special local CTA to overcome this */
 465 #define CTA(TEST)       _CTA_1(TEST, n_FILE, __LINE__)
 466 #define LCTA(TEST)      _LCTA_1(TEST, n_FILE, __LINE__)
 467
 468 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 201112L
 469 # define n_CTA(T,M) _Static_assert(T, M)
 470 # define n_LCTA(T,M) _Static_assert(T, M)
 471 #else
 472 # define n_CTA(T,M)  _CTA_1(T, n_FILE, __LINE__)
 473 # define n_LCTA(T,M) _LCTA_1(T, n_FILE, __LINE__)
 474 #endif
 475 #define n_CTAV(T) n_CTA(T, "Unexpected value of constant")
 476 #define n_LCTAV(T) n_LCTA(T, "Unexpected value of constant")
 477
 478 #ifdef n_MAIN_SOURCE
 479 # define n_MCTA(T,M) n_CTA(T, M);
 480 #else
 481 # define n_MCTA(T,M)
 482 #endif
 483
 484 #define _CTA_1(T,F,L)   _CTA_2(T, F, L)
 485 #define _CTA_2(T,F,L)  \
 486    typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
 487 #define _LCTA_1(T,F,L)  _LCTA_2(T, F, L)
 488 #define _LCTA_2(T,F,L) \
 489 do {\
 490    typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
 491    ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
 492    UNUSED(__i_am_unused__);\
 493 } while (0)
 494
 495 #define UNINIT(N,V)     N = V
 496
 497 #undef ISPOW2
 498 #define ISPOW2(X)       ((((X) - 1) & (X)) == 0)
 499 #undef MIN
 500 #define MIN(A, B)       ((A) < (B) ? (A) : (B))
 501 #undef MAX
 502 #define MAX(A, B)       ((A) < (B) ? (B) : (A))
 503 #undef ABS
 504 #define ABS(A)          ((A) < 0 ? -(A) : (A))
 505
 506 #undef DBG
 507 #undef NDBG
 508 #ifndef HAVE_DEBUG
 509 # undef assert
 510 # define assert(X)      UNUSED(0)
 511 # define DBG(X)
 512 # define NDBG(X)        X
 513 # define DBGOR(X,Y)     Y
 514 #else
 515 # define DBG(X)         X
 516 # define NDBG(X)
 517 # define DBGOR(X,Y)     X
 518 #endif
 519
 520 /* Translation (init in main.c) */
 521 #undef _
 522 #undef N_
 523 #undef V_
 524 #define _(S)            S
 525 #define N_(S)           S
 526 #define V_(S)           S
 527
 528 /*
 529  * Types
 530  */
 531
 532 #ifdef UINT8_MAX
 533 # define UI8_MAX        UINT8_MAX
 534 # define SI8_MIN        INT8_MIN
 535 # define SI8_MAX        INT8_MAX
 536 typedef uint8_t         ui8_t;
 537 typedef int8_t          si8_t;
 538 #elif UCHAR_MAX != 255
 539 # error UCHAR_MAX must be 255
 540 #else
 541 # define UI8_MAX        UCHAR_MAX
 542 # define SI8_MIN        CHAR_MIN
 543 # define SI8_MAX        CHAR_MAX
 544 typedef unsigned char   ui8_t;
 545 typedef signed char     si8_t;
 546 #endif
 547
 548 #if !defined PRIu8 || !defined PRId8
 549 # undef PRIu8
 550 # undef PRId8
 551 # define PRIu8          "hhu"
 552 # define PRId8          "hhd"
 553 #endif
 554
 555 #ifdef UINT16_MAX
 556 # define UI16_MAX       UINT16_MAX
 557 # define SI16_MIN       INT16_MIN
 558 # define SI16_MAX       INT16_MAX
 559 typedef uint16_t        ui16_t;
 560 typedef int16_t         si16_t;
 561 #elif USHRT_MAX != 0xFFFFu
 562 # error USHRT_MAX must be 0xFFFF
 563 #else
 564 # define UI16_MAX       USHRT_MAX
 565 # define SI16_MIN       SHRT_MIN
 566 # define SI16_MAX       SHRT_MAX
 567 typedef unsigned short  ui16_t;
 568 typedef signed short    si16_t;
 569 #endif
 570
 571 #if !defined PRIu16 || !defined PRId16
 572 # undef PRIu16
 573 # undef PRId16
 574 # if UI16_MAX == UINT_MAX
 575 #  define PRIu16        "u"
 576 #  define PRId16        "d"
 577 # else
 578 #  define PRIu16        "hu"
 579 #  define PRId16        "hd"
 580 # endif
 581 #endif
 582
 583 #ifdef UINT32_MAX
 584 # define UI32_MAX       UINT32_MAX
 585 # define SI32_MIN       INT32_MIN
 586 # define SI32_MAX       INT32_MAX
 587 typedef uint32_t        ui32_t;
 588 typedef int32_t         si32_t;
 589 #elif ULONG_MAX == 0xFFFFFFFFu
 590 # define UI32_MAX       ULONG_MAX
 591 # define SI32_MIN       LONG_MIN
 592 # define SI32_MAX       LONG_MAX
 593 typedef unsigned long int  ui32_t;
 594 typedef signed long int    si32_t;
 595 #elif UINT_MAX != 0xFFFFFFFFu
 596 # error UINT_MAX must be 0xFFFFFFFF
 597 #else
 598 # define UI32_MAX       UINT_MAX
 599 # define SI32_MIN       INT_MIN
 600 # define SI32_MAX       INT_MAX
 601 typedef unsigned int    ui32_t;
 602 typedef signed int      si32_t;
 603 #endif
 604
 605 #if !defined PRIu32 || !defined PRId32
 606 # undef PRIu32
 607 # undef PRId32
 608 # if UI32_MAX == ULONG_MAX
 609 #  define PRIu32        "lu"
 610 #  define PRId32        "ld"
 611 # else
 612 #  define PRIu32        "u"
 613 #  define PRId32        "d"
 614 # endif
 615 #endif
 616
 617 #ifdef UINT64_MAX
 618 # define UI64_MAX       UINT64_MAX
 619 # define SI64_MIN       INT64_MIN
 620 # define SI64_MAX       INT64_MAX
 621 typedef uint64_t        ui64_t;
 622 typedef int64_t         si64_t;
 623 #elif ULONG_MAX <= 0xFFFFFFFFu
 624 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
 625 #  error We need a 64 bit integer
 626 # else
 627 #  define UI64_MAX      ULLONG_MAX
 628 #  define SI64_MIN      LLONG_MIN
 629 #  define SI64_MAX      LLONG_MAX
 630 __EXTEN typedef unsigned long long  ui64_t;
 631 __EXTEN typedef signed long long    si64_t;
 632 # endif
 633 #else
 634 # define UI64_MAX       ULONG_MAX
 635 # define SI64_MIN       LONG_MIN
 636 # define SI64_MAX       LONG_MAX
 637 typedef unsigned long   ui64_t;
 638 typedef signed long     si64_t;
 639 #endif
 640
 641 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
 642 # undef PRIu64
 643 # undef PRId64
 644 # undef PRIX64
 645 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
 646 #  define PRIu64        "llu"
 647 #  define PRId64        "lld"
 648 #  define PRIX64        "llX"
 649 # else
 650 #  define PRIu64        "lu"
 651 #  define PRId64        "ld"
 652 #  define PRIX64        "lX"
 653 # endif
 654 #endif
 655
 656 /* (So that we can use UICMP() for size_t comparison, too) */
 657 typedef size_t          uiz_t;
 658 typedef ssize_t         siz_t;
 659
 660 #undef PRIuZ
 661 #undef PRIdZ
 662 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 663 # define PRIuZ          "zu"
 664 # define PRIdZ          "zd"
 665 # define UIZ_MAX        SIZE_MAX
 666 #elif defined SIZE_MAX
 667   /* UnixWare has size_t as unsigned as required but uses a signed limit
 668    * constant (which is thus false!) */
 669 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
 670 #  define PRIuZ         PRIu64
 671 #  define PRIdZ         PRId64
 672 n_MCTA(sizeof(size_t) == sizeof(ui64_t),
 673    "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
 674 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
 675 #  define PRIuZ         PRIu32
 676 #  define PRIdZ         PRId32
 677 n_MCTA(sizeof(size_t) == sizeof(ui32_t),
 678    "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
 679 # else
 680 #  error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
 681 # endif
 682 # define UIZ_MAX        SIZE_MAX
 683 #endif
 684 #ifndef PRIuZ
 685 # define PRIuZ          "lu"
 686 # define PRIdZ          "ld"
 687 n_MCTA(sizeof(size_t) == sizeof(unsigned long),
 688    "Format string mismatch, compile with ISO C99 compiler (-std=c99)!")
 689 # define UIZ_MAX        ULONG_MAX
 690 #endif
 691
 692 #ifndef UINTPTR_MAX
 693 # ifdef SIZE_MAX
 694 #  define uintptr_t     size_t
 695 #  define UINTPTR_MAX   SIZE_MAX
 696 # else
 697 #  define uintptr_t     unsigned long
 698 #  define UINTPTR_MAX   ULONG_MAX
 699 # endif
 700 #endif
 701
 702 #if !defined PRIuPTR || !defined PRIXPTR
 703 # undef PRIuPTR
 704 # undef PRIXPTR
 705 # if UINTPTR_MAX == ULONG_MAX
 706 #  define PRIuPTR       "lu"
 707 #  define PRIXPTR       "lX"
 708 # else
 709 #  define PRIuPTR       "u"
 710 #  define PRIXPTR       "X"
 711 # endif
 712 #endif
 713
 714 enum {FAL0, TRU1, TRUM1 = -1};
 715 typedef si8_t           bool_t;
 716
 717 /* Add shorter aliases for "normal" integers */
 718 typedef unsigned long   ul_i;
 719 typedef unsigned int    ui_i;
 720 typedef unsigned short  us_i;
 721 typedef unsigned char   uc_i;
 722
 723 typedef signed long     sl_i;
 724 typedef signed int      si_i;
 725 typedef signed short    ss_i;
 726 typedef signed char     sc_i;
 727
 728 typedef void (          *sighandler_type)(int);
 729
 730 enum authtype {
 731    AUTHTYPE_NONE     = 1<<0,
 732    AUTHTYPE_PLAIN    = 1<<1,  /* POP3: APOP is covered by this */
 733    AUTHTYPE_LOGIN    = 1<<2,
 734    AUTHTYPE_CRAM_MD5 = 1<<3,
 735    AUTHTYPE_GSSAPI   = 1<<4
 736 };
 737
 738 enum expand_addr_flags {
 739    EAF_NONE       = 0,        /* -> EAF_NOFILE | EAF_NOPIPE */
 740    EAF_RESTRICT   = 1<<0,     /* "restrict" (do unless interaktive / -[~#]) */
 741    EAF_FAIL       = 1<<1,     /* "fail" */
 742    /* Bits reused by enum expand_addr_check_mode! */
 743    EAF_FILE       = 1<<3,     /* +"file" targets */
 744    EAF_PIPE       = 1<<4,     /* +"pipe" command pipe targets */
 745    EAF_NAME       = 1<<5,     /* +"name"s (non-address) names / MTA aliases */
 746    EAF_ADDR       = 1<<6,     /* +"addr" network address (contain "@") */
 747
 748    EAF_TARGET_MASK  = EAF_FILE | EAF_PIPE | EAF_NAME | EAF_ADDR,
 749    EAF_RESTRICT_TARGETS = EAF_NAME | EAF_ADDR /* (default set if not set) */
 750 };
 751
 752 enum expand_addr_check_mode {
 753    EACM_NONE      = 0,        /* Don't care about *expandaddr* */
 754    EACM_NORMAL    = 1<<0,     /* Use our normal *expandaddr* checking */
 755    EACM_STRICT    = 1<<1,     /* Never allow any file or pipe addresse */
 756    EACM_MODE_MASK = 0x3,      /* _NORMAL and _STRICT are mutual! */
 757
 758    EACM_NOLOG     = 1<<2,     /* Don't log check errors */
 759
 760    /* Some special overwrites of EAF_TARGETs.
 761     * May NOT clash with EAF_* bits which may be ORd to these here! */
 762
 763    EACM_NONAME    = 1<<16
 764 };
 765
 766 #ifdef HAVE_COLOUR
 767 /* We do have several contexts of colour IDs; since only one of them can be
 768  * active at any given time let's share the value range */
 769 enum n_colour_ctx{
 770    n_COLOUR_CTX_SUM,
 771    n_COLOUR_CTX_VIEW,
 772    n_COLOUR_CTX_MLE,
 773    n__COLOUR_CTX_MAX
 774 };
 775
 776 enum n_colour_id{
 777    /* Header summary */
 778    n_COLOUR_ID_SUM_DOTMARK = 0,
 779    n_COLOUR_ID_SUM_HEADER,
 780    n_COLOUR_ID_SUM_THREAD,
 781
 782    /* Message display */
 783    n_COLOUR_ID_VIEW_FROM_ = 0,
 784    n_COLOUR_ID_VIEW_HEADER,
 785    n_COLOUR_ID_VIEW_MSGINFO,
 786    n_COLOUR_ID_VIEW_PARTINFO,
 787
 788    /* Mailx-Line-Editor */
 789    n_COLOUR_ID_MLE_POSITION = 0,
 790    n_COLOUR_ID_MLE_PROMPT,
 791
 792    n__COLOUR_IDS = n_COLOUR_ID_VIEW_PARTINFO + 1
 793 };
 794
 795 /* Colour preconditions, let's call them tags, cannot be an enum because for
 796  * message display they are the actual header name of the current header.  Thus
 797  * let's use constants of pseudo pointers */
 798 # define n_COLOUR_TAG_SUM_DOT ((char*)-2)
 799 # define n_COLOUR_TAG_SUM_OLDER ((char*)-3)
 800 #endif /* HAVE_COLOUR */
 801
 802 enum conversion {
 803    CONV_NONE,        /* no conversion */
 804    CONV_7BIT,        /* no conversion, is 7bit */
 805    CONV_FROMQP,      /* convert from quoted-printable */
 806    CONV_TOQP,        /* convert to quoted-printable */
 807    CONV_8BIT,        /* convert to 8bit (iconv) */
 808    CONV_FROMB64,     /* convert from base64 */
 809    CONV_FROMB64_T,   /* convert from base64/text */
 810    CONV_TOB64,       /* convert to base64 */
 811    CONV_FROMHDR,     /* convert from RFC1522 format */
 812    CONV_TOHDR,       /* convert to RFC1522 format */
 813    CONV_TOHDR_A      /* convert addresses for header */
 814 };
 815
 816 enum cproto {
 817    CPROTO_SMTP,
 818    CPROTO_POP3
 819 };
 820
 821 enum n_dotlock_state{
 822    n_DLS_NONE,
 823    n_DLS_CANT_CHDIR,    /* Failed to chdir(2) into desired path */
 824    n_DLS_NAMETOOLONG,   /* Lock file name would be too long */
 825    n_DLS_ROFS,          /* Read-only filesystem (no error, mailbox RO) */
 826    n_DLS_NOPERM,        /* No permission to creat lock file */
 827    n_DLS_NOEXEC,        /* Privilege separated dotlocker not found */
 828    n_DLS_PRIVFAILED,    /* Rising privileges failed in dotlocker */
 829    n_DLS_EXIST,         /* Lock file already exists, stale lock? */
 830    n_DLS_FISHY,         /* Something makes us think bad of situation */
 831    n_DLS_DUNNO,         /* Catch-all error */
 832    n_DLS_PING,          /* Not an error, but have to wait for lock */
 833    n_DLS_ABANDON = 1<<7 /* ORd to any but _NONE: give up, don't retry */
 834 };
 835
 836 enum exit_status {
 837    EXIT_OK        = EXIT_SUCCESS,
 838    EXIT_ERR       = EXIT_FAILURE,
 839    EXIT_USE       = 64,       /* sysexits.h:EX_USAGE */
 840    EXIT_NOUSER    = 67,       /* :EX_NOUSER */
 841    EXIT_COLL_ABORT = 1<<1,    /* Message collection was aborted */
 842    EXIT_SEND_ERROR = 1<<2     /* Unspecified send error occurred */
 843 };
 844
 845 enum fedit_mode {
 846    FEDIT_NONE     = 0,
 847    FEDIT_SYSBOX   = 1<<0,     /* %: prefix */
 848    FEDIT_RDONLY   = 1<<1,     /* Readonly (per-box, OPT_R_FLAG is global) */
 849    FEDIT_NEWMAIL  = 1<<2      /* `newmail' operation TODO OBSOLETE THIS! */
 850 };
 851
 852 enum fexp_mode {
 853    FEXP_FULL,                 /* Full expansion */
 854    FEXP_LOCAL     = 1<<0,     /* Result must be local file/maildir */
 855    FEXP_SHELL     = 1<<1,     /* No folder %,#,&,+ stuff, yet sh(1) */
 856    FEXP_NSHORTCUT = 1<<2,     /* Don't expand shortcuts */
 857    FEXP_SILENT    = 1<<3,     /* Don't print but only return errors */
 858    FEXP_MULTIOK   = 1<<4,     /* Expansion to many entries is ok */
 859    FEXP_NSHELL    = 1<<5      /* Don't do shell word exp. (but ~/, $VAR) */
 860 };
 861
 862 enum n_file_lock_type{
 863    FLT_READ,
 864    FLT_WRITE
 865 };
 866
 867 enum mimecontent {
 868    MIME_UNKNOWN,     /* unknown content */
 869    MIME_SUBHDR,      /* inside a multipart subheader */
 870    MIME_822,         /* message/rfc822 content */
 871    MIME_MESSAGE,     /* other message/ content */
 872    MIME_TEXT_PLAIN,  /* text/plain content */
 873    MIME_TEXT_HTML,   /* text/html content */
 874    MIME_TEXT,        /* other text/ content */
 875    MIME_ALTERNATIVE, /* multipart/alternative content */
 876    MIME_RELATED,     /* mime/related (RFC 2387) */
 877    MIME_DIGEST,      /* multipart/digest content */
 878    MIME_MULTI,       /* other multipart/ content */
 879    MIME_PKCS7,       /* PKCS7 content */
 880    MIME_DISCARD      /* content is discarded */
 881 };
 882
 883 enum mime_counter_evidence {
 884    MIMECE_NONE,
 885    MIMECE_SET        = 1<<0,  /* *mime-counter-evidence* was set */
 886    MIMECE_BIN_OVWR   = 1<<1,  /* appli../octet-stream: check, ovw if possible */
 887    MIMECE_ALL_OVWR   = 1<<2,  /* all: check, ovw if possible */
 888    MIMECE_BIN_PARSE  = 1<<3   /* appli../octet-stream: classify contents last */
 889 };
 890
 891 /* Content-Transfer-Encodings as defined in RFC 2045:
 892  * - Quoted-Printable, section 6.7
 893  * - Base64, section 6.8 */
 894 #define QP_LINESIZE     (4 * 19)       /* Max. compliant QP linesize */
 895
 896 #define B64_LINESIZE    (4 * 19)       /* Max. compliant Base64 linesize */
 897 #define B64_ENCODE_INPUT_PER_LINE 57   /* Max. input for Base64 encode/line */
 898
 899 enum mime_enc {
 900    MIMEE_NONE,       /* message is not in MIME format */
 901    MIMEE_BIN,        /* message is in binary encoding */
 902    MIMEE_8B,         /* message is in 8bit encoding */
 903    MIMEE_7B,         /* message is in 7bit encoding */
 904    MIMEE_QP,         /* message is quoted-printable */
 905    MIMEE_B64         /* message is in base64 encoding */
 906 };
 907
 908 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
 909 enum mime_enc_flags {
 910    MIMEEF_NONE,
 911    MIMEEF_SALLOC     = 1<<0,  /* Use salloc(), not srealloc().. */
 912    /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
 913    MIMEEF_BUF        = 1<<1,
 914    MIMEEF_CRLF       = 1<<2,  /* (encode) Append "\r\n" to lines */
 915    MIMEEF_LF         = 1<<3,  /* (encode) Append "\n" to lines */
 916    /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
 917     * inject the desired line-ending whenever a linewrap is desired */
 918    MIMEEF_MULTILINE  = 1<<4,
 919    /* (encode) Quote with header rules, do not generate soft NL breaks?
 920     * For mustquote(), specifies wether special RFC 2047 header rules
 921     * should be used instead */
 922    MIMEEF_ISHEAD     = 1<<5,
 923    /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
 924     * that characters which would not be reported as "must-quote" when
 925     * detecting wether quoting is necessary at all will be reported as
 926     * "must-quote" if they have to be encoded in an encoded word */
 927    MIMEEF_ISENCWORD  = 1<<6,
 928    __MIMEEF_LAST     = 6
 929 };
 930
 931 enum qpflags {
 932    QP_NONE        = MIMEEF_NONE,
 933    QP_SALLOC      = MIMEEF_SALLOC,
 934    QP_BUF         = MIMEEF_BUF,
 935    QP_ISHEAD      = MIMEEF_ISHEAD,
 936    QP_ISENCWORD   = MIMEEF_ISENCWORD
 937 };
 938
 939 enum b64flags {
 940    B64_NONE       = MIMEEF_NONE,
 941    B64_SALLOC     = MIMEEF_SALLOC,
 942    B64_BUF        = MIMEEF_BUF,
 943    B64_CRLF       = MIMEEF_CRLF,
 944    B64_LF         = MIMEEF_LF,
 945    B64_MULTILINE  = MIMEEF_MULTILINE,
 946    /* Not used, but for clarity only */
 947    B64_ISHEAD     = MIMEEF_ISHEAD,
 948    B64_ISENCWORD  = MIMEEF_ISENCWORD,
 949    /* Special version of Base64, "Base64URL", according to RFC 4648.
 950     * Only supported for encoding! */
 951    B64_RFC4648URL = 1<<(__MIMEEF_LAST+1),
 952    /* Don't use any ("=") padding;
 953     * may NOT be used with any of _CRLF, _LF or _MULTILINE */
 954    B64_NOPAD      = 1<<(__MIMEEF_LAST+2)
 955 };
 956
 957 enum mime_parse_flags {
 958    MIME_PARSE_NONE      = 0,
 959    MIME_PARSE_DECRYPT   = 1<<0,
 960    MIME_PARSE_PARTS     = 1<<1
 961 };
 962
 963 enum mime_handler_flags {
 964    MIME_HDL_NULL,                /* No pipe- mimetype handler, go away */
 965    MIME_HDL_CMD,                 /* Normal command */
 966    MIME_HDL_TEXT,                /* @ special cmd to force treatment as text */
 967    MIME_HDL_PTF,                 /* A special pointer-to-function handler */
 968    MIME_HDL_MSG,                 /* Display msg (returned as command string) */
 969    MIME_HDL_TYPE_MASK   = 7,
 970    MIME_HDL_ISQUOTE     = 1<<4,  /* Is quote action (we have info, keep it!) */
 971    MIME_HDL_NOQUOTE     = 1<<5,  /* No MIME for quoting */
 972    MIME_HDL_ALWAYS      = 1<<6,  /* Handler shall run for multi-msg actions */
 973    MIME_HDL_ASYNC       = 1<<7,  /* Should run asynchronously */
 974    MIME_HDL_NEEDSTERM   = 1<<8,  /* Takes over terminal */
 975    MIME_HDL_TMPF        = 1<<9,  /* Create temporary file (zero-sized) */
 976    MIME_HDL_TMPF_FILL   = 1<<10, /* Fill in the msg body content */
 977    MIME_HDL_TMPF_UNLINK = 1<<11  /* Delete it later again */
 978 };
 979
 980 enum mlist_state {
 981    MLIST_OTHER       = 0,     /* Normal address */
 982    MLIST_KNOWN       = 1,     /* A known `mlist' */
 983    MLIST_SUBSCRIBED  = -1     /* A `mlsubscribe'd list */
 984 };
 985
 986 enum oflags {
 987    OF_RDONLY      = 1<<0,
 988    OF_WRONLY      = 1<<1,
 989    OF_RDWR        = 1<<2,
 990    OF_APPEND      = 1<<3,
 991    OF_CREATE      = 1<<4,
 992    OF_TRUNC       = 1<<5,
 993    OF_EXCL        = 1<<6,
 994    OF_CLOEXEC     = 1<<7,     /* TODO not used, always implied!  CHANGE!! */
 995    OF_UNLINK      = 1<<8,     /* Only for Ftmp(): unlink(2) after creation */
 996    OF_HOLDSIGS    = 1<<9,     /* Mutual with OF_UNLINK - await Ftmp_free() */
 997    OF_REGISTER    = 1<<10,    /* Register file in our file table */
 998    OF_REGISTER_UNLINK = 1<<11, /* unlink(2) upon unreg.; _REGISTER asserted! */
 999    OF_SUFFIX      = 1<<12     /* Ftmp() name hint is mandatory! extension! */
1000 };
1001
1002 enum okay {
1003    STOP = 0,
1004    OKAY = 1
1005 };
1006
1007 enum okey_xlook_mode {
1008    OXM_PLAIN      = 1<<0,     /* Plain key always tested */
1009    OXM_H_P        = 1<<1,     /* Check PLAIN-.url_h_p */
1010    OXM_U_H_P      = 1<<2,     /* Check PLAIN-.url_u_h_p */
1011    OXM_ALL        = 0x7
1012 };
1013
1014 /* <0 means "stop" unless *prompt* extensions are enabled. */
1015 enum prompt_exp {
1016    PROMPT_STOP    = -1,       /* \c */
1017    /* *prompt* extensions: \$, \@ etc. */
1018    PROMPT_DOLLAR  = -2,
1019    PROMPT_AT      = -3
1020 };
1021
1022 enum protocol {
1023    PROTO_FILE,       /* refers to a local file */
1024    PROTO_POP3,       /* is a pop3 server string */
1025    PROTO_MAILDIR,    /* refers to a maildir folder */
1026    PROTO_UNKNOWN     /* unknown protocol */
1027 };
1028
1029 enum sendaction {
1030    SEND_MBOX,        /* no conversion to perform */
1031    SEND_RFC822,      /* no conversion, no From_ line */
1032    SEND_TODISP,      /* convert to displayable form */
1033    SEND_TODISP_ALL,  /* same, include all MIME parts */
1034    SEND_SHOW,        /* convert to 'show' command form */
1035    SEND_TOSRCH,      /* convert for IMAP SEARCH */
1036    SEND_TOFILE,      /* convert for saving body to a file */
1037    SEND_TOPIPE,      /* convert for pipe-content/subc. */
1038    SEND_QUOTE,       /* convert for quoting */
1039    SEND_QUOTE_ALL,   /* same, include all MIME parts */
1040    SEND_DECRYPT      /* decrypt */
1041 };
1042
1043 enum n_sigman_flags{
1044    n_SIGMAN_NONE = 0,
1045    n_SIGMAN_HUP = 1<<0,
1046    n_SIGMAN_INT = 1<<1,
1047    n_SIGMAN_QUIT = 1<<2,
1048    n_SIGMAN_TERM = 1<<3,
1049    n_SIGMAN_PIPE = 1<<4,
1050
1051    n_SIGMAN_IGN_HUP = 1<<5,
1052    n_SIGMAN_IGN_INT = 1<<6,
1053    n_SIGMAN_IGN_QUIT = 1<<7,
1054    n_SIGMAN_IGN_TERM = 1<<8,
1055
1056    n_SIGMAN_ALL = 0xFF,
1057    /* Mostly for _leave() reraise flags */
1058    n_SIGMAN_VIPSIGS = n_SIGMAN_HUP | n_SIGMAN_INT | n_SIGMAN_QUIT |
1059          n_SIGMAN_TERM,
1060    n_SIGMAN_NTTYOUT_PIPE = 1<<16,
1061    n_SIGMAN_VIPSIGS_NTTYOUT = n_SIGMAN_HUP | n_SIGMAN_INT | n_SIGMAN_QUIT |
1062          n_SIGMAN_TERM | n_SIGMAN_NTTYOUT_PIPE,
1063
1064    n__SIGMAN_PING = 1<<17
1065 };
1066
1067 #ifdef HAVE_SSL
1068 enum ssl_verify_level {
1069    SSL_VERIFY_IGNORE,
1070    SSL_VERIFY_WARN,
1071    SSL_VERIFY_ASK,
1072    SSL_VERIFY_STRICT
1073 };
1074 #endif
1075
1076 enum tdflags {
1077    TD_NONE,                   /* no display conversion */
1078    TD_ISPR        = 1<<0,     /* use isprint() checks */
1079    TD_ICONV       = 1<<1,     /* use iconv() */
1080    TD_DELCTRL     = 1<<2,     /* delete control characters */
1081
1082    /*
1083     * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
1084     * enum sendaction, and may thus NOT clash with their bit range!
1085     */
1086    _TD_EOF        = 1<<14,    /* EOF seen, last round! */
1087    _TD_BUFCOPY    = 1<<15     /* Buffer may be constant, copy it */
1088 };
1089
1090 #ifdef n_HAVE_TCAP
1091 enum n_termcap_captype{
1092    n_TERMCAP_CAPTYPE_NONE = 0,
1093    /* Internally we share the bitspace, so ensure no value ends up as 0 */
1094    n_TERMCAP_CAPTYPE_BOOL = 1,
1095    n_TERMCAP_CAPTYPE_NUMERIC,
1096    n_TERMCAP_CAPTYPE_STRING,
1097    n__TERMCAP_CAPTYPE_MAX
1098 };
1099
1100 /* Termcap commands; different to queries commands perform actions.
1101  * Commands are resolved upon init time, and are all termcap(5)-compatible,
1102  * therefore we use the short termcap(5) names.
1103  * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1104  * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1105  * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1106  * a | vertical bar or end-of-comment ends processing; see termcap.c.
1107  * We may use the free-form part after | for the "Variable String" and notes on
1108  * necessary termcap_cmd() arguments; if those are in [] brackets they are not
1109  * regular but are only used when the command, i.e., its effect, is somehow
1110  * simulated / faked by a builtin fallback implementation.
1111  * Availability of builtin fallback indicated by leading @ (at-sign) */
1112 enum n_termcap_cmd{
1113 # ifdef HAVE_TERMCAP
1114    n_TERMCAP_CMD_te, /* rmcup/te, STRING | exit_ca_mode: -,- */
1115    n_TERMCAP_CMD_ti, /* smcup/ti, STRING | enter_ca_mode: -,- */
1116
1117    n_TERMCAP_CMD_ks, /* smkx/ks, STRING | keypad_xmit: -,- */
1118    n_TERMCAP_CMD_ke, /* rmkx/ke, STRING | keypad_local: -,- */
1119
1120    n_TERMCAP_CMD_cd, /* ed/cd, STRING | clr_eos: -,- */
1121    n_TERMCAP_CMD_cl, /* clear/cl, STRING | clear_screen(+home): -,- */
1122    n_TERMCAP_CMD_ho, /* home/ho, STRING | cursor_home: -,- */
1123 # endif
1124
1125 # ifdef HAVE_MLE
1126    n_TERMCAP_CMD_ce, /* el/ce, STRING | @ clr_eol: [start-column],- */
1127    n_TERMCAP_CMD_ch, /* hpa/ch, STRING, IDX1 | column_address: column,- */
1128    n_TERMCAP_CMD_cr, /* cr/cr, STRING | @ carriage_return: -,- */
1129    n_TERMCAP_CMD_le, /* cub1/le, STRING, CNT | @ cursor_left: count,- */
1130    n_TERMCAP_CMD_nd, /* cuf1/nd, STRING, CNT | @ cursor_right: count,- */
1131 # endif
1132
1133    n__TERMCAP_CMD_MAX,
1134    n__TERMCAP_CMD_MASK = (1<<24) - 1,
1135
1136    /* Only perform command if ca-mode is used */
1137    n_TERMCAP_CMD_FLAG_CA_MODE = 1<<29,
1138    /* I/O should be flushed after command completed */
1139    n_TERMCAP_CMD_FLAG_FLUSH = 1<<30
1140 };
1141
1142 /* Termcap queries; a query is a command that returns a struct n_termcap_value.
1143  * Queries are resolved once they are used first, and may not be termcap(5)-
1144  * compatible, therefore we use terminfo(5) names.
1145  * Note this is parsed by mk-tcap-map.pl, which expects the syntax
1146  * "CONSTANT, COMMENT" where COMMENT is "Capname/TCap-Code, TYPE[, FLAGS]",
1147  * and one of Capname and TCap-Code may be the string "-" meaning ENOENT;
1148  * a | vertical bar or end-of-comment ends processing; see termcap.c.
1149  * We may use the free-form part after | for the "Variable String" and notes.
1150  * The "xkey | X:" keys are Dickey's xterm extensions, see (our) manual */
1151 enum n_termcap_query{
1152 # ifdef HAVE_COLOUR
1153    n_TERMCAP_QUERY_colors, /* colors/Co, NUMERIC | max_colors */
1154 # endif
1155
1156    /* --mk-tcap-map--: only KEY_BINDINGS follow.  DON'T CHANGE THIS LINE! */
1157    /* Update the `bind' manual on change! */
1158 # ifdef HAVE_KEY_BINDINGS
1159    n_TERMCAP_QUERY_key_backspace, /* kbs/kb, STRING */
1160    n_TERMCAP_QUERY_key_dc,       /* kdch1/kD, STRING | delete-character */
1161       n_TERMCAP_QUERY_key_sdc,      /* kDC / *4, STRING | ..shifted */
1162    n_TERMCAP_QUERY_key_eol,      /* kel/kE, STRING | clear-to-end-of-line */
1163    n_TERMCAP_QUERY_key_exit,     /* kext/@9, STRING */
1164    n_TERMCAP_QUERY_key_ic,       /* kich1/kI, STRING | insert character */
1165       n_TERMCAP_QUERY_key_sic,      /* kIC/#3, STRING | ..shifted */
1166    n_TERMCAP_QUERY_key_home,     /* khome/kh, STRING */
1167       n_TERMCAP_QUERY_key_shome,    /* kHOM/#2, STRING | ..shifted */
1168    n_TERMCAP_QUERY_key_end,      /* kend/@7, STRING */
1169       n_TERMCAP_QUERY_key_send,     /* kEND / *7, STRING | ..shifted */
1170    n_TERMCAP_QUERY_key_npage,    /* knp/kN, STRING */
1171    n_TERMCAP_QUERY_key_ppage,    /* kpp/kP, STRING */
1172    n_TERMCAP_QUERY_key_left,     /* kcub1/kl, STRING */
1173       n_TERMCAP_QUERY_key_sleft,    /* kLFT/#4, STRING | ..shifted */
1174       n_TERMCAP_QUERY_xkey_aleft,   /* kLFT3/-, STRING | X: Alt+left */
1175       n_TERMCAP_QUERY_xkey_cleft,   /* kLFT5/-, STRING | X: Control+left */
1176    n_TERMCAP_QUERY_key_right,    /* kcuf1/kr, STRING */
1177       n_TERMCAP_QUERY_key_sright,   /* kRIT/%i, STRING | ..shifted */
1178       n_TERMCAP_QUERY_xkey_aright,  /* kRIT3/-, STRING | X: Alt+right */
1179       n_TERMCAP_QUERY_xkey_cright,  /* kRIT5/-, STRING | X: Control+right */
1180    n_TERMCAP_QUERY_key_down,     /* kcud1/kd, STRING */
1181       n_TERMCAP_QUERY_xkey_sdown,   /* kDN/-, STRING | ..shifted */
1182       n_TERMCAP_QUERY_xkey_adown,   /* kDN3/-, STRING | X: Alt+down */
1183       n_TERMCAP_QUERY_xkey_cdown,   /* kDN5/-, STRING | X: Control+down */
1184    n_TERMCAP_QUERY_key_up,       /* kcuu1/ku, STRING */
1185       n_TERMCAP_QUERY_xkey_sup,     /* kUP/-, STRING | ..shifted */
1186       n_TERMCAP_QUERY_xkey_aup,     /* kUP3/-, STRING | X: Alt+up */
1187       n_TERMCAP_QUERY_xkey_cup,     /* kUP5/-, STRING | X: Control+up */
1188    n_TERMCAP_QUERY_kf0,          /* kf0/k0, STRING */
1189    n_TERMCAP_QUERY_kf1,          /* kf1/k1, STRING */
1190    n_TERMCAP_QUERY_kf2,          /* kf2/k2, STRING */
1191    n_TERMCAP_QUERY_kf3,          /* kf3/k3, STRING */
1192    n_TERMCAP_QUERY_kf4,          /* kf4/k4, STRING */
1193    n_TERMCAP_QUERY_kf5,          /* kf5/k5, STRING */
1194    n_TERMCAP_QUERY_kf6,          /* kf6/k6, STRING */
1195    n_TERMCAP_QUERY_kf7,          /* kf7/k7, STRING */
1196    n_TERMCAP_QUERY_kf8,          /* kf8/k8, STRING */
1197    n_TERMCAP_QUERY_kf9,          /* kf9/k9, STRING */
1198    n_TERMCAP_QUERY_kf10,         /* kf10/k;, STRING */
1199    n_TERMCAP_QUERY_kf11,         /* kf11/F1, STRING */
1200    n_TERMCAP_QUERY_kf12,         /* kf12/F2, STRING */
1201    n_TERMCAP_QUERY_kf13,         /* kf13/F3, STRING */
1202    n_TERMCAP_QUERY_kf14,         /* kf14/F4, STRING */
1203    n_TERMCAP_QUERY_kf15,         /* kf15/F5, STRING */
1204    n_TERMCAP_QUERY_kf16,         /* kf16/F6, STRING */
1205    n_TERMCAP_QUERY_kf17,         /* kf17/F7, STRING */
1206    n_TERMCAP_QUERY_kf18,         /* kf18/F8, STRING */
1207    n_TERMCAP_QUERY_kf19,         /* kf19/F9, STRING */
1208 # endif /* HAVE_KEY_BINDINGS */
1209
1210    n__TERMCAP_QUERY_MAX
1211 };
1212 #endif /* n_HAVE_TCAP */
1213
1214 enum user_options {
1215    OPT_NONE,
1216    OPT_DEBUG      = 1u<< 0,   /* -d / *debug* */
1217    OPT_VERB       = 1u<< 1,   /* -v / *verbose* */
1218    OPT_VERBVERB   = 1u<< 2,   /* .. even more verbosity */
1219    OPT_EXISTONLY  = 1u<< 3,   /* -e */
1220    OPT_HEADERSONLY = 1u<<4,   /* -H */
1221    OPT_HEADERLIST = 1u<< 5,   /* -L */
1222    OPT_QUICKRUN_MASK = OPT_EXISTONLY | OPT_HEADERSONLY | OPT_HEADERLIST,
1223    OPT_E_FLAG     = 1u<< 7,   /* -E / *skipemptybody* */
1224    OPT_F_FLAG     = 1u<< 8,   /* -F */
1225    OPT_N_FLAG     = 1u<< 9,   /* -N / *header* */
1226    OPT_R_FLAG     = 1u<<10,   /* -R */
1227    OPT_r_FLAG     = 1u<<11,   /* -r (plus option_r_arg) */
1228    OPT_t_FLAG     = 1u<<12,   /* -t */
1229    OPT_u_FLAG     = 1u<<13,   /* -u / $USER and pw->pw_uid != getuid(2) */
1230    OPT_TILDE_FLAG = 1u<<14,   /* -~ */
1231    OPT_BATCH_FLAG = 1u<<15,   /* -# */
1232
1233    /*  */
1234    OPT_MEMDEBUG   = 1<<16,    /* *memdebug* */
1235
1236    /*  */
1237    OPT_SENDMODE   = 1u<<17,   /* Usage case forces send mode */
1238    OPT_TTYIN      = 1u<<18,
1239    OPT_TTYOUT     = 1u<<19,
1240    OPT_INTERACTIVE = 1u<<20,
1241    OPT_UNICODE    = 1u<<21,   /* We're in an UTF-8 environment */
1242    OPT_ENC_MBSTATE = 1u<<22,  /* Multibyte environment with shift states */
1243
1244    /* Some easy-access shortcuts */
1245    OPT_D_V        = OPT_DEBUG | OPT_VERB,
1246    OPT_D_VV       = OPT_DEBUG | OPT_VERBVERB,
1247    OPT_D_V_VV     = OPT_DEBUG | OPT_VERB | OPT_VERBVERB
1248 };
1249
1250 #define OBSOLETE(X) \
1251 do {\
1252    if (options & OPT_D_V_VV)\
1253       n_err("%s: %s\n", _("Obsoletion warning"), X);\
1254 } while (0)
1255 #define OBSOLETE2(X,Y) \
1256 do {\
1257    if (options & OPT_D_V_VV)\
1258       n_err("%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
1259 } while (0)
1260
1261 enum program_state {
1262    PS_NONE           = 0,
1263    PS_STARTED        = 1<< 0,       /* main.c startup code passed, functional */
1264
1265    PS_EXIT           = 1<< 1,       /* Exit request pending */
1266    PS_SOURCING       = 1<< 2,       /* During load() or `source' */
1267    PS_RECURSED       = 1<< 3,       /* State machine recursed, e.g. `~:CMD' */
1268    PS_ROBOT          = 1<< 4,       /* State machine in non-interactive state */
1269
1270    PS_EVAL_ERROR     = 1<< 5,       /* Last evaluate() command failed */
1271
1272    PS_HOOK_NEWMAIL   = 1<< 6,
1273    PS_HOOK           = 1<< 7,
1274    PS_HOOK_MASK      = PS_HOOK_NEWMAIL | PS_HOOK,
1275
1276    PS_EDIT           = 1<< 8,       /* Current mailbox not a "system mailbox" */
1277    PS_SETFILE_OPENED = 1<< 9,       /* (hack) setfile() opened a new box */
1278    PS_SAW_COMMAND    = 1<<10,       /* ..after mailbox switch */
1279
1280    PS_DID_PRINT_DOT  = 1<<16,       /* Current message has been printed */
1281
1282    PS_MSGLIST_SAW_NO = 1<<17,       /* Last *LIST saw numerics */
1283    PS_MSGLIST_DIRECT = 1<<18,       /* One msg was directly chosen by number */
1284    PS_MSGLIST_MASK   = PS_MSGLIST_SAW_NO | PS_MSGLIST_DIRECT,
1285
1286    PS_HEADER_NEEDED_MIME = 1<<20,   /* mime_write_tohdr() needed x TODO HACK! */
1287
1288    PS_COLOUR_ACTIVE  = 1<<22,       /* n_colour_env_create().._gut() cycle */
1289
1290    /* Various first-time-init switches */
1291    PS_ERRORS_NOTED   = 1<<24,       /* Ring of `errors' content, print msg */
1292    PS_ATTACHMENTS_NOTED = 1<<25,    /* Attachment filename quoting noted */
1293    PS_t_FLAG         = 1<<26,       /* OPT_t_FLAG made persistant */
1294    PS_TERMCAP_DISABLE = 1<<27,      /* HAVE_TERMCAP: *termcap-disable* was set */
1295    PS_TERMCAP_CA_MODE = 1<<28,      /* HAVE_TERMCAP: ca_mode available & used */
1296    PS_HISTORY_LOADED = 1<<29        /* Command line editor history loaded */
1297 };
1298
1299 /* A large enum with all the boolean and value options a.k.a their keys.
1300  * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1301  * ok_[bv]set() and ok_[bv]clear().
1302  * Note: see the comments in accmacvar.c before changing *anything* in here! */
1303 enum okeys {
1304    /* TODO likely temporary hook data, v15 drop */
1305    ok_v_on_compose_enter,
1306    ok_v_on_compose_leave,
1307    ok_v_compose_from,
1308    ok_v_compose_sender,
1309    ok_v_compose_to,
1310    ok_v_compose_cc,
1311    ok_v_compose_bcc,
1312    ok_v_compose_subject,
1313
1314    ok_b_add_file_recipients,
1315    ok_v_agent_shell_lookup,
1316    ok_b_allnet,
1317    ok_b_append,
1318    ok_b_ask,
1319    ok_b_askatend,
1320    ok_b_askattach,
1321    ok_b_askbcc,
1322    ok_b_askcc,
1323    ok_b_asksign,
1324    ok_b_asksub,
1325    ok_b_attachment_ask_content_description,
1326    ok_b_attachment_ask_content_disposition,
1327    ok_b_attachment_ask_content_id,
1328    ok_b_attachment_ask_content_type,
1329    ok_v_attrlist,
1330    ok_v_autobcc,
1331    ok_v_autocc,
1332    ok_b_autocollapse,
1333    ok_b_autoprint,
1334 ok_b_autothread,
1335    ok_v_autosort,
1336
1337    ok_b_bang,
1338    ok_b_batch_exit_on_error,
1339    ok_b_bsdannounce,
1340    ok_b_bsdcompat,
1341    ok_b_bsdflags,
1342    ok_b_bsdheadline,
1343    ok_b_bsdmsgs,
1344    ok_b_bsdorder,
1345    ok_b_bsdset,
1346
1347    ok_v_charset_7bit,
1348    ok_v_charset_8bit,
1349    ok_v_charset_unknown_8bit,
1350    ok_v_cmd,
1351    ok_b_colour_disable,
1352    ok_b_colour_pager,
1353    ok_v_crt,
1354    ok_v_customhdr,
1355
1356    ok_v_DEAD,
1357    ok_v_datefield,
1358    ok_v_datefield_markout_older,
1359    ok_b_debug,                         /* {special=1} */
1360    ok_b_disposition_notification_send,
1361    ok_b_dot,
1362    ok_b_dotlock_ignore_error,
1363
1364    ok_v_EDITOR,
1365    ok_b_editalong,
1366    ok_b_editheaders,
1367 ok_b_emptybox,
1368    ok_b_emptystart,
1369    ok_v_encoding,
1370    ok_v_escape,
1371    ok_v_expandaddr,
1372    ok_v_expandargv,
1373
1374    ok_v_features,                      /* {rdonly=1,virtual=_features} */
1375    ok_b_flipr,
1376    ok_v_folder,                        /* {special=1} */
1377    ok_v_folder_hook,
1378    ok_b_followup_to,
1379    ok_v_followup_to_honour,
1380    ok_b_forward_as_attachment,
1381    ok_v_from,
1382    ok_b_fullnames,
1383    ok_v_fwdheading,
1384
1385    ok_b_header,                        /* {special=1} */
1386    ok_v_headline,
1387    ok_v_headline_bidi,
1388    ok_v_history_file,
1389    ok_b_history_gabby,
1390    ok_b_history_gabby_persist,
1391    ok_v_history_size,
1392    ok_b_hold,
1393    ok_v_hostname,
1394
1395    ok_b_idna_disable,
1396    ok_b_ignore,
1397    ok_b_ignoreeof,
1398    ok_v_indentprefix,
1399
1400    ok_b_keep,
1401    ok_b_keep_content_length,
1402    ok_b_keepsave,
1403
1404    ok_v_LISTER,
1405    ok_b_line_editor_disable,
1406
1407    ok_v_MAIL,
1408    ok_v_MBOX,
1409    ok_b_markanswered,
1410    ok_b_mbox_rfc4155,
1411    ok_b_memdebug,                      /* {special=1} */
1412    ok_b_message_id_disable,
1413    ok_v_message_inject_head,
1414    ok_v_message_inject_tail,
1415    ok_b_metoo,
1416    ok_b_mime_allow_text_controls,
1417    ok_b_mime_alternative_favour_rich,
1418    ok_v_mime_counter_evidence,
1419    ok_v_mimetypes_load_control,
1420
1421    ok_v_NAIL_EXTRA_RC,                 /* {name=NAIL_EXTRA_RC} */
1422 ok_v_NAIL_HEAD,                     /* {name=NAIL_HEAD} */
1423 ok_v_NAIL_HISTFILE,                 /* {name=NAIL_HISTFILE} */
1424 ok_v_NAIL_HISTSIZE,                 /* {name=NAIL_HISTSIZE} */
1425 ok_v_NAIL_TAIL,                     /* {name=NAIL_TAIL} */
1426    ok_b_netrc_lookup,
1427    ok_v_newfolders,
1428    ok_v_newmail,
1429
1430    ok_b_outfolder,
1431
1432    ok_v_PAGER,
1433    ok_b_page,
1434    ok_v_password,
1435    ok_b_piperaw,
1436    ok_v_pop3_auth,
1437    ok_b_pop3_bulk_load,
1438    ok_v_pop3_keepalive,
1439    ok_b_pop3_no_apop,
1440    ok_b_pop3_use_starttls,
1441    ok_b_print_alternatives,
1442    ok_v_prompt,
1443
1444    ok_b_quiet,
1445    ok_v_quote,
1446    ok_b_quote_as_attachment,
1447    ok_v_quote_fold,
1448
1449    ok_b_recipients_in_cc,
1450    ok_v_record,
1451    ok_b_record_resent,
1452    ok_b_reply_in_same_charset,
1453    ok_v_reply_strings,
1454    ok_v_replyto,
1455    ok_v_reply_to_honour,
1456    ok_b_rfc822_body_from_,             /* {name=rfc822-body-from_} */
1457
1458    ok_v_SHELL,
1459    ok_b_save,
1460    ok_v_screen,
1461    ok_b_searchheaders,
1462    ok_v_sendcharsets,
1463    ok_b_sendcharsets_else_ttycharset,
1464    ok_v_sender,
1465    ok_v_sendmail,
1466    ok_v_sendmail_arguments,
1467    ok_b_sendmail_no_default_arguments,
1468    ok_v_sendmail_progname,
1469    ok_b_sendwait,
1470    ok_b_showlast,
1471    ok_b_showname,
1472    ok_b_showto,
1473    ok_v_Sign,
1474    ok_v_sign,
1475    ok_v_signature,
1476    ok_b_skipemptybody,                 /* {special=1} */
1477    ok_v_smime_ca_dir,
1478    ok_v_smime_ca_file,
1479    ok_v_smime_cipher,
1480    ok_v_smime_crl_dir,
1481    ok_v_smime_crl_file,
1482    /* smime-encrypt-USER@HOST */
1483    ok_b_smime_force_encryption,
1484    ok_b_smime_no_default_ca,
1485    ok_b_smime_sign,
1486    ok_v_smime_sign_cert,
1487    ok_v_smime_sign_include_certs,
1488    ok_v_smime_sign_message_digest,
1489    ok_v_smtp,
1490    ok_v_smtp_auth,
1491 ok_v_smtp_auth_password,
1492 ok_v_smtp_auth_user,
1493    ok_v_smtp_hostname,
1494    ok_b_smtp_use_starttls,
1495    ok_v_spam_interface,
1496    ok_v_spam_maxsize,
1497    ok_v_spamc_command,
1498    ok_v_spamc_arguments,
1499    ok_v_spamc_user,
1500    ok_v_spamd_socket,
1501    ok_v_spamd_user,
1502    ok_v_spamfilter_ham,
1503    ok_v_spamfilter_noham,
1504    ok_v_spamfilter_nospam,
1505    ok_v_spamfilter_rate,
1506    ok_v_spamfilter_rate_scanscore,
1507    ok_v_spamfilter_spam,
1508    ok_v_ssl_ca_dir,
1509    ok_v_ssl_ca_file,
1510    ok_v_ssl_cert,
1511    ok_v_ssl_cipher_list,
1512    ok_v_ssl_config_file,
1513    ok_v_ssl_crl_dir,
1514    ok_v_ssl_crl_file,
1515    ok_v_ssl_key,
1516    ok_v_ssl_method,
1517    ok_b_ssl_no_default_ca,
1518    ok_v_ssl_protocol,
1519    ok_v_ssl_rand_egd,
1520    ok_v_ssl_rand_file,
1521    ok_v_ssl_verify,
1522    ok_v_stealthmua,
1523
1524    ok_v_termcap,
1525    ok_b_termcap_disable,
1526    ok_v_toplines,
1527    ok_v_ttycharset,
1528
1529    ok_v_user,
1530
1531    ok_v_VISUAL,
1532    ok_b_v15_compat,
1533    ok_b_verbose,                       /* {special=1} */
1534    ok_v_version,                       /* {rdonly=1,virtual=VERSION} */
1535    ok_v_version_major,                 /* {rdonly=1,virtual=VERSION_MAJOR} */
1536    ok_v_version_minor,                 /* {rdonly=1,virtual=VERSION_MINOR} */
1537    ok_v_version_update,                /* {rdonly=1,virtual=VERSION_UPDATE} */
1538
1539    ok_b_writebackedited
1540 };
1541
1542 /* Locale-independent character classes */
1543 enum {
1544    C_CNTRL        = 0000,
1545    C_BLANK        = 0001,
1546    C_WHITE        = 0002,
1547    C_SPACE        = 0004,
1548    C_PUNCT        = 0010,
1549    C_OCTAL        = 0020,
1550    C_DIGIT        = 0040,
1551    C_UPPER        = 0100,
1552    C_LOWER        = 0200
1553 };
1554
1555 struct str {
1556    char     *s;      /* the string's content */
1557    size_t   l;       /* the stings's length */
1558 };
1559
1560 struct n_string{
1561    char *s_dat;         /*@ May contain NULs, not automatically terminated */
1562    ui32_t s_len;        /*@ gth of string */
1563 #ifdef HAVE_BYTE_ORDER_LITTLE
1564    ui32_t s_auto : 1;   /* Stored in auto-reclaimed storage? */
1565 #endif
1566    ui32_t s_size : 31;  /* of .s_dat, -1 */
1567 #ifndef HAVE_BYTE_ORDER_LITTLE
1568    ui32_t s_auto : 1;
1569 #endif
1570 };
1571
1572 struct bidi_info {
1573    struct str  bi_start;      /* Start of (possibly) bidirectional text */
1574    struct str  bi_end;        /* End of ... */
1575    size_t      bi_pad;        /* No of visual columns to reserve for BIDI pad */
1576 };
1577
1578 #ifdef HAVE_COLOUR
1579 struct n_colour_pen;
1580 #endif
1581
1582 struct url {
1583    char const     *url_input;       /* Input as given (really) */
1584    enum cproto    url_cproto;       /* Communication protocol as given */
1585    bool_t         url_needs_tls;    /* Wether the protocol uses SSL/TLS */
1586    bool_t         url_had_user;     /* Wether .url_user was part of the URL */
1587    ui16_t         url_portno;       /* atoi .url_port or default, host endian */
1588    char const     *url_port;        /* Port (if given) or NULL */
1589    char           url_proto[14];    /* Communication protocol as 'xy\0//' */
1590    ui8_t          url_proto_len;    /* Length of .url_proto ('\0' index) */
1591    ui8_t          url_proto_xlen;   /* .. if '\0' is replaced with ':' */
1592    struct str     url_user;         /* User, exactly as given / looked up */
1593    struct str     url_user_enc;     /* User, urlxenc()oded */
1594    struct str     url_pass;         /* Pass (urlxdec()oded) or NULL */
1595    struct str     url_host;         /* Service hostname */
1596    struct str     url_path;         /* Path suffix or NULL */
1597    /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1598    struct str     url_h_p;          /* .url_host[:.url_port] */
1599    /* .url_user@.url_host
1600     * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1601     * *hostname*)!  (And may later be overwritten according to *from*!) */
1602    struct str     url_u_h;
1603    struct str     url_u_h_p;        /* .url_user@.url_host[:.url_port] */
1604    struct str     url_eu_h_p;       /* .url_user_enc@.url_host[:.url_port] */
1605    char const     *url_p_u_h_p;     /* .url_proto://.url_u_h_p */
1606    char const     *url_p_eu_h_p;    /* .url_proto://.url_eu_h_p */
1607    char const     *url_p_eu_h_p_p;  /* .url_proto://.url_eu_h_p[/.url_path] */
1608 };
1609
1610 struct ccred {
1611    enum cproto    cc_cproto;     /* Communication protocol */
1612    enum authtype  cc_authtype;   /* Desired authentication */
1613    char const     *cc_auth;      /* Authentication type as string */
1614    struct str     cc_user;       /* User (urlxdec()oded) or NULL */
1615    struct str     cc_pass;       /* Password (urlxdec()oded) or NULL */
1616 };
1617
1618 #ifdef HAVE_DOTLOCK
1619 struct n_dotlock_info{
1620    char const *di_file_name;  /* Mailbox to lock */
1621    char const *di_lock_name;  /* .di_file_name + .lock */
1622    char const *di_hostname;   /* ..filled in parent (due resolver delays) */
1623    char const *di_randstr;    /* ..ditto, random string */
1624    size_t di_pollmsecs;       /* Delay in between locking attempts */
1625    struct stat *di_stb;
1626 };
1627 #endif
1628
1629 /* Execution context bundles  */
1630 struct n_exec_ctx{
1631
1632    void *l_smem;                 /* salloc() memory TODO -> memraw? */
1633    /* TODO our new per-exec-ctx memory "allocators" are yet very dumb.
1634     * TODO for v15 those should not be wrapping nodes but real allocators */
1635    struct n_mem_raw *l_memraw;   /* n_mem_alloc() (/ n_mem_free()) */
1636    struct n_mem_wrap *l_memwrap; /* n_mem_wrap() (/ n_mem_unwrap()) */
1637 };
1638
1639 struct n_mem_raw{
1640    struct n_mem_raw *mr_prev;
1641    struct n_mem_raw *mr_next;
1642    char mr_buf[VFIELD_SIZE(0)];
1643 };
1644
1645 struct n_mem_wrap{
1646    struct n_mem_wrap *mw_prev;
1647    struct n_mem_wrap *mw_next;
1648    void *mw_obj;
1649    void (*mw_dtor)(void *obj);
1650 };
1651
1652 struct mime_handler {
1653    enum mime_handler_flags mh_flags;
1654    struct str  mh_msg;           /* Message describing this command */
1655    /* XXX union{} the following? */
1656    char const  *mh_shell_cmd;    /* For MIME_HDL_CMD */
1657    int         (*mh_ptf)(void);  /* PTF main() for MIME_HDL_PTF */
1658 };
1659
1660 struct quoteflt {
1661    FILE        *qf_os;        /* Output stream */
1662    char const  *qf_pfix;
1663    ui32_t      qf_pfix_len;   /* Length of prefix: 0: bypass */
1664    ui32_t      qf_qfold_min;  /* Simple way: wrote prefix? */
1665 #ifdef HAVE_QUOTE_FOLD
1666    ui32_t      qf_qfold_max;  /* Otherwise: line lengths */
1667    ui8_t       qf_state;      /* *quote-fold* state machine */
1668    bool_t      qf_brk_isws;   /* Breakpoint is at WS */
1669    ui8_t       __dummy[2];
1670    ui32_t      qf_wscnt;      /* Whitespace count */
1671    ui32_t      qf_brkl;       /* Breakpoint */
1672    ui32_t      qf_brkw;       /* Visual width, breakpoint */
1673    ui32_t      qf_datw;       /* Current visual output line width */
1674    struct str  qf_dat;        /* Current visual output line */
1675    struct str  qf_currq;      /* Current quote, compressed */
1676    mbstate_t   qf_mbps[2];
1677 #endif
1678 };
1679
1680 #ifdef HAVE_FILTER_HTML_TAGSOUP
1681 struct htmlflt {
1682    FILE        *hf_os;        /* Output stream */
1683    ui32_t      hf_flags;
1684    ui32_t      hf_lmax;       /* Maximum byte +1 in .hf_line/4 */
1685    ui32_t      hf_len;        /* Current bytes in .hf_line */
1686    ui32_t      hf_last_ws;    /* Last whitespace on line (fold purposes) */
1687    ui32_t      hf_mboff;      /* Last offset for "mbtowc" */
1688    ui32_t      hf_mbwidth;    /* We count characters not bytes if possible */
1689    char        *hf_line;      /* Output line buffer - MUST be last field! */
1690    si32_t      hf_href_dist;  /* Count of lines since last HREF flush */
1691    ui32_t      hf_href_no;    /* HREF sequence number */
1692    struct htmlflt_href *hf_hrefs;
1693    struct htmlflt_tag const *hf_ign_tag; /* Tag that will end ignore mode */
1694    char        *hf_curr;      /* Current cursor into .hf_bdat */
1695    char        *hf_bmax;      /* Maximum byte in .hf_bdat +1 */
1696    char        *hf_bdat;      /* (Temporary) Tag content data storage */
1697 };
1698 #endif
1699
1700 struct search_expr {
1701    char const  *ss_where;     /* ..to search for the expr. (not always used) */
1702    char const  *ss_sexpr;     /* String search expr.; NULL: use .ss_regex */
1703 #ifdef HAVE_REGEX
1704    regex_t     ss_regex;
1705 #endif
1706 };
1707
1708 /* This is somewhat temporary for pre v15 */
1709 struct n_sigman{
1710    ui32_t sm_flags;           /* enum n_sigman_flags */
1711    int sm_signo;
1712    struct n_sigman *sm_outer;
1713    sighandler_type sm_ohup;
1714    sighandler_type sm_oint;
1715    sighandler_type sm_oquit;
1716    sighandler_type sm_oterm;
1717    sighandler_type sm_opipe;
1718    sigjmp_buf sm_jump;
1719 };
1720
1721 struct termios_state {
1722    struct termios ts_tios;
1723    char        *ts_linebuf;
1724    size_t      ts_linesize;
1725    bool_t      ts_needs_reset;
1726 };
1727
1728 #define termios_state_reset() \
1729 do {\
1730    if (termios_state.ts_needs_reset) {\
1731       tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1732       termios_state.ts_needs_reset = FAL0;\
1733    }\
1734 } while (0)
1735
1736 #ifdef n_HAVE_TCAP
1737 struct n_termcap_value{
1738    enum n_termcap_captype tv_captype;
1739    ui8_t tv__dummy[4];
1740    union n_termcap_value_data{
1741       bool_t tvd_bool;
1742       ui32_t tvd_numeric;
1743       char const *tvd_string;
1744    } tv_data;
1745 };
1746 #endif
1747
1748 struct time_current {
1749    time_t      tc_time;
1750    struct tm   tc_gm;
1751    struct tm   tc_local;
1752    char        tc_ctime[32];
1753 };
1754
1755 struct sock {                 /* data associated with a socket */
1756    int         s_fd;          /* file descriptor */
1757 #ifdef HAVE_SSL
1758    int         s_use_ssl;     /* SSL is used */
1759 # ifdef HAVE_OPENSSL
1760    void        *s_ssl;        /* SSL object */
1761 # endif
1762 #endif
1763    char        *s_wbuf;       /* for buffered writes */
1764    int         s_wbufsize;    /* allocated size of s_buf */
1765    int         s_wbufpos;     /* position of first empty data byte */
1766    char        *s_rbufptr;    /* read pointer to s_rbuf */
1767    int         s_rsz;         /* size of last read in s_rbuf */
1768    char const  *s_desc;       /* description of error messages */
1769    void        (*s_onclose)(void);     /* execute on close */
1770    char        s_rbuf[LINESIZE + 1];   /* for buffered reads */
1771 };
1772
1773 struct sockconn {
1774    struct url     sc_url;
1775    struct ccred   sc_cred;
1776    struct sock    sc_sock;
1777 };
1778
1779 struct mailbox {
1780    enum {
1781       MB_NONE     = 000,      /* no reply expected */
1782       MB_COMD     = 001,      /* command reply expected */
1783       MB_MULT     = 002,      /* multiline reply expected */
1784       MB_PREAUTH  = 004,      /* not in authenticated state */
1785       MB_BYE      = 010       /* may accept a BYE state */
1786    }           mb_active;
1787    FILE        *mb_itf;       /* temp file with messages, read open */
1788    FILE        *mb_otf;       /* same, write open */
1789    char        *mb_sorted;    /* sort method */
1790    enum {
1791       MB_VOID,       /* no type (e. g. connection failed) */
1792       MB_FILE,       /* local file */
1793       MB_POP3,       /* POP3 mailbox */
1794       MB_MAILDIR     /* maildir folder */
1795    }           mb_type;       /* type of mailbox */
1796    enum {
1797       MB_DELE = 01,  /* may delete messages in mailbox */
1798       MB_EDIT = 02   /* may edit messages in mailbox */
1799    }           mb_perm;
1800    int mb_threaded;           /* mailbox has been threaded */
1801    struct sock mb_sock;       /* socket structure */
1802 };
1803
1804 enum needspec {
1805    NEED_UNSPEC,      /* unspecified need, don't fetch */
1806    NEED_HEADER,      /* need the header of a message */
1807    NEED_BODY         /* need header and body of a message */
1808 };
1809
1810 enum havespec {
1811    HAVE_NOTHING,              /* nothing downloaded yet */
1812    HAVE_HEADER    = 01,       /* header is downloaded */
1813    HAVE_BODY      = 02        /* entire message is downloaded */
1814 };
1815
1816 /* flag bits. Attention: Flags that are used in cache.c may not change */
1817 enum mflag {
1818    MUSED          = (1<< 0),  /* entry is used, but this bit isn't */
1819    MDELETED       = (1<< 1),  /* entry has been deleted */
1820    MSAVED         = (1<< 2),  /* entry has been saved */
1821    MTOUCH         = (1<< 3),  /* entry has been noticed */
1822    MPRESERVE      = (1<< 4),  /* keep entry in sys mailbox */
1823    MMARK          = (1<< 5),  /* message is marked! */
1824    MODIFY         = (1<< 6),  /* message has been modified */
1825    MNEW           = (1<< 7),  /* message has never been seen */
1826    MREAD          = (1<< 8),  /* message has been read sometime. */
1827    MSTATUS        = (1<< 9),  /* message status has changed */
1828    MBOX           = (1<<10),  /* Send this to mbox, regardless */
1829    MNOFROM        = (1<<11),  /* no From line */
1830    MHIDDEN        = (1<<12),  /* message is hidden to user */
1831    MBOXED         = (1<<13),  /* message has been sent to mbox */
1832    MNEWEST        = (1<<14),  /* message is very new (newmail) */
1833    MFLAG          = (1<<15),  /* message has been flagged recently */
1834    MUNFLAG        = (1<<16),  /* message has been unflagged */
1835    MFLAGGED       = (1<<17),  /* message is `flagged' */
1836    MANSWER        = (1<<18),  /* message has been answered recently */
1837    MUNANSWER      = (1<<19),  /* message has been unanswered */
1838    MANSWERED      = (1<<20),  /* message is `answered' */
1839    MDRAFT         = (1<<21),  /* message has been drafted recently */
1840    MUNDRAFT       = (1<<22),  /* message has been undrafted */
1841    MDRAFTED       = (1<<23),  /* message is marked as `draft' */
1842    MOLDMARK       = (1<<24),  /* messages was marked previously */
1843    MSPAM          = (1<<25),  /* message is classified as spam */
1844    MSPAMUNSURE    = (1<<26)   /* message may be spam, but it is unsure */
1845 };
1846 #define MMNORM          (MDELETED | MSAVED | MHIDDEN)
1847 #define MMNDEL          (MDELETED | MHIDDEN)
1848
1849 #define visible(mp)     (((mp)->m_flag & MMNDEL) == 0)
1850
1851 struct mimepart {
1852    enum mflag  m_flag;        /* flags */
1853    enum havespec m_have;      /* downloaded parts of the part */
1854 #ifdef HAVE_SPAM
1855    ui32_t      m_spamscore;   /* Spam score as int, 24:8 bits */
1856 #endif
1857    int         m_block;       /* block number of this part */
1858    size_t      m_offset;      /* offset in block of part */
1859    size_t      m_size;        /* Bytes in the part */
1860    size_t      m_xsize;       /* Bytes in the full part */
1861    long        m_lines;       /* Lines in the message */
1862    long        m_xlines;      /* Lines in the full message */
1863    time_t      m_time;        /* time the message was sent */
1864    char const  *m_from;       /* message sender */
1865    struct mimepart *m_nextpart;     /* next part at same level */
1866    struct mimepart *m_multipart;    /* parts of multipart */
1867    struct mimepart *m_parent;       /* enclosing multipart part */
1868    char const  *m_ct_type;          /* content-type */
1869    char const  *m_ct_type_plain;    /* content-type without specs */
1870    char const  *m_ct_type_usr_ovwr; /* Forcefully overwritten one */
1871    enum mimecontent m_mimecontent;  /* same in enum */
1872    char const  *m_charset;    /* charset */
1873    char const  *m_ct_enc;     /* content-transfer-encoding */
1874    enum mime_enc m_mime_enc;     /* same in enum */
1875    char        *m_partstring; /* part level string */
1876    char        *m_filename;   /* attachment filename */
1877 };
1878
1879 struct message {
1880    enum mflag  m_flag;        /* flags */
1881    enum havespec m_have;      /* downloaded parts of the message */
1882 #ifdef HAVE_SPAM
1883    ui32_t      m_spamscore;   /* Spam score as int, 24:8 bits */
1884 #endif
1885    int         m_block;       /* block number of this message */
1886    size_t      m_offset;      /* offset in block of message */
1887    size_t      m_size;        /* Bytes in the message */
1888    size_t      m_xsize;       /* Bytes in the full message */
1889    long        m_lines;       /* Lines in the message */
1890    long        m_xlines;      /* Lines in the full message */
1891    time_t      m_time;        /* time the message was sent */
1892    time_t      m_date;        /* time in the 'Date' field */
1893    unsigned    m_idhash;      /* hash on Message-ID for threads */
1894    struct message *m_child;   /* first child of this message */
1895    struct message *m_younger; /* younger brother of this message */
1896    struct message *m_elder;   /* elder brother of this message */
1897    struct message *m_parent;  /* parent of this message */
1898    unsigned    m_level;       /* thread level of message */
1899    long        m_threadpos;   /* position in threaded display */
1900    char        *m_maildir_file;  /* original maildir file of msg */
1901    ui32_t      m_maildir_hash;   /* hash of file name in maildir sub */
1902    int         m_collapsed;      /* collapsed thread information */
1903 };
1904
1905 /* Given a file address, determine the block number it represents */
1906 #define mailx_blockof(off)                ((int) ((off) / 4096))
1907 #define mailx_offsetof(off)               ((int) ((off) % 4096))
1908 #define mailx_positionof(block, offset)   ((off_t)(block) * 4096 + (offset))
1909
1910 /* Argument types */
1911 enum argtype {
1912    ARG_MSGLIST    = 0,        /* Message list type */
1913    ARG_STRLIST    = 1,        /* A pure string */
1914    ARG_RAWLIST    = 2,        /* Shell string list */
1915    ARG_NOLIST     = 3,        /* Just plain 0 */
1916    ARG_NDMLIST    = 4,        /* Message list, no defaults */
1917    ARG_ECHOLIST   = 5,        /* Like raw list, but keep quote chars */
1918    ARG_ARGMASK    = 7,        /* Mask of the above */
1919
1920    ARG_A          = 1u<< 4,   /* Needs an active mailbox */
1921    ARG_F          = 1u<< 5,   /* Is a conditional command */
1922    ARG_H          = 1u<< 6,   /* Never place in history */
1923    ARG_I          = 1u<< 7,   /* Interactive command bit */
1924    ARG_M          = 1u<< 8,   /* Legal from send mode bit */
1925    ARG_P          = 1u<< 9,   /* Autoprint dot after command */
1926    ARG_R          = 1u<<10,   /* Cannot be called from collect / recursion */
1927    ARG_S          = 1u<<11,   /* Cannot be called unless PS_STARTED (POSIX) */
1928    ARG_T          = 1u<<12,   /* Is a transparent command */
1929    ARG_V          = 1u<<13,   /* Places data in temporary_arg_v_store */
1930    ARG_W          = 1u<<14,   /* Invalid when read only bit */
1931    ARG_O          = 1u<<15    /* OBSOLETE()d command */
1932 };
1933
1934 enum gfield {
1935    GTO            = 1<< 0,    /* Grab To: line */
1936    GSUBJECT       = 1<< 1,    /* Likewise, Subject: line */
1937    GCC            = 1<< 2,    /* And the Cc: line */
1938    GBCC           = 1<< 3,    /* And also the Bcc: line */
1939
1940    GNL            = 1<< 4,    /* Print blank line after */
1941    GDEL           = 1<< 5,    /* Entity removed from list */
1942    GCOMMA         = 1<< 6,    /* detract() puts in commas */
1943    GUA            = 1<< 7,    /* User-Agent field */
1944    GMIME          = 1<< 8,    /* MIME 1.0 fields */
1945    GMSGID         = 1<< 9,    /* a Message-ID */
1946    GNAMEONLY      = 1<<10,    /* detract() does NOT use fullnames */
1947
1948    GIDENT         = 1<<11,    /* From:, Reply-To:, MFT: (user headers) */
1949    GREF           = 1<<12,    /* References:, In-Reply-To:, (Message-ID:) */
1950    GDATE          = 1<<13,    /* Date: field */
1951    GFULL          = 1<<14,    /* Include full names, comments etc. */
1952    GSKIN          = 1<<15,    /* Skin names */
1953    GEXTRA         = 1<<16,    /* Extra fields (mostly like GIDENT XXX) */
1954    GFILES         = 1<<17,    /* Include filename and pipe addresses */
1955    GFULLEXTRA     = 1<<18     /* Only with GFULL: GFULL less address */
1956 };
1957 #define GMASK           (GTO | GSUBJECT | GCC | GBCC)
1958
1959 enum header_flags {
1960    HF_NONE        = 0,
1961    HF_LIST_REPLY  = 1<< 0,
1962    HF_MFT_SENDER  = 1<< 1,    /* Add ourselves to Mail-Followup-To: */
1963    HF_RECIPIENT_RECORD = 1<<10, /* Save message in file named after rec. */
1964    HF__NEXT_SHIFT = 11
1965 };
1966
1967 /* Structure used to pass about the current state of a message (header) */
1968 struct n_header_field{
1969    struct n_header_field *hf_next;
1970    ui32_t hf_nl;              /* Field-name length */
1971    ui32_t hf_bl;              /* Field-body length*/
1972    char hf_dat[VFIELD_SIZE(0)];
1973 };
1974
1975 struct header {
1976    ui32_t      h_flags;       /* enum header_flags bits */
1977    ui32_t      h_dummy;
1978    struct name *h_to;         /* Dynamic "To:" string */
1979    char        *h_subject;    /* Subject string */
1980    struct name *h_cc;         /* Carbon copies string */
1981    struct name *h_bcc;        /* Blind carbon copies */
1982    struct name *h_ref;        /* References (possibly overridden) */
1983    struct attachment *h_attach; /* MIME attachments */
1984    char        *h_charset;    /* preferred charset */
1985    struct name *h_from;       /* overridden "From:" field */
1986    struct name *h_sender;     /* overridden "Sender:" field */
1987    struct name *h_replyto;    /* overridden "Reply-To:" field */
1988    struct name *h_message_id; /* overridden "Message-ID:" field */
1989    struct name *h_in_reply_to;/* overridden "In-Reply-To:" field */
1990    struct name *h_mft;        /* Mail-Followup-To */
1991    char const  *h_list_post;  /* Address from List-Post:, for `Lreply' */
1992    struct n_header_field *h_user_headers;
1993    struct n_header_field *h_custom_headers; /* (Cached result) */
1994 };
1995
1996 /* Handling of namelist nodes used in processing the recipients of mail and
1997  * aliases, inspection of mail-addresses and all that kind of stuff */
1998 enum nameflags {
1999    NAME_NAME_SALLOC        = 1<< 0, /* .n_name is doped */
2000    NAME_FULLNAME_SALLOC    = 1<< 1, /* .n_fullname is doped */
2001    NAME_SKINNED            = 1<< 2, /* Is actually skin()ned */
2002    NAME_IDNA               = 1<< 3, /* IDNA was applied */
2003
2004    NAME_ADDRSPEC_CHECKED   = 1<< 4, /* Address has been .. and */
2005    NAME_ADDRSPEC_ISFILE    = 1<< 5, /* ..is a file path */
2006    NAME_ADDRSPEC_ISPIPE    = 1<< 6, /* ..is a command for piping */
2007    NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
2008    NAME_ADDRSPEC_ISNAME    = 1<< 7, /* ..is a valid mail network address */
2009    NAME_ADDRSPEC_ISADDR    = 1<< 8, /* ..is a valid mail network address */
2010
2011    NAME_ADDRSPEC_ERR_EMPTY = 1<< 9, /* An empty string (or NULL) */
2012    NAME_ADDRSPEC_ERR_ATSEQ = 1<<10, /* Weird @ sequence */
2013    NAME_ADDRSPEC_ERR_CHAR  = 1<<11, /* Invalid character */
2014    NAME_ADDRSPEC_ERR_IDNA  = 1<<12, /* IDNA convertion failed */
2015    NAME_ADDRSPEC_INVALID   = NAME_ADDRSPEC_ERR_EMPTY |
2016          NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
2017          NAME_ADDRSPEC_ERR_IDNA,
2018
2019    /* Error storage (we must fit in 31-bit) */
2020    _NAME_SHIFTWC  = 13,
2021    _NAME_MAXWC    = 0x3FFFF,
2022    _NAME_MASKWC   = _NAME_MAXWC << _NAME_SHIFTWC
2023 };
2024
2025 /* In the !_ERR_EMPTY case, the failing character can be queried */
2026 #define NAME_ADDRSPEC_ERR_GETWC(F)  \
2027    ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
2028 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
2029 do {\
2030    (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
2031          (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
2032 } while (0)
2033
2034 struct name {
2035    struct name *n_flink;      /* Forward link in list. */
2036    struct name *n_blink;      /* Backward list link */
2037    enum gfield n_type;        /* From which list it came */
2038    enum nameflags n_flags;    /* enum nameflags */
2039    char        *n_name;       /* This fella's address */
2040    char        *n_fullname;   /* Ditto, unless GFULL including comment */
2041    char        *n_fullextra;  /* GFULL, without address */
2042 };
2043
2044 struct addrguts {
2045    char const  *ag_input;     /* Input string as given */
2046    size_t      ag_ilen;       /* strlen() of input */
2047    size_t      ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
2048    size_t      ag_iaddr_aend; /* ..and one past its end */
2049    char        *ag_skinned;   /* Output (alloced if !=.ag_input) */
2050    size_t      ag_slen;       /* strlen() of .ag_skinned */
2051    size_t      ag_sdom_start; /* Start of domain in .ag_skinned, */
2052    enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
2053 };
2054
2055 /* MIME attachments */
2056 enum attach_conv {
2057    AC_DEFAULT,       /* _get_lc() -> _iter_*() */
2058    AC_FIX_OUTCS,     /* _get_lc() -> "charset=" .a_charset */
2059    AC_FIX_INCS,      /* "charset=".a_input_charset (nocnv) */
2060    AC_TMPFILE        /* attachment.a_tmpf is converted */
2061 };
2062
2063 struct attachment {
2064    struct attachment *a_flink;   /* Forward link in list. */
2065    struct attachment *a_blink;   /* Backward list link */
2066    char const  *a_name;       /* file name */
2067    char const  *a_content_type;  /* content type */
2068    char const  *a_content_disposition; /* content disposition */
2069    char const  *a_content_id; /* content id */
2070    char const  *a_content_description; /* content description */
2071    char const  *a_input_charset; /* Interpretation depends on .a_conv */
2072    char const  *a_charset;    /* ... */
2073    FILE        *a_tmpf;       /* If AC_TMPFILE */
2074    enum attach_conv a_conv;   /* User chosen conversion */
2075    int         a_msgno;       /* message number */
2076 };
2077
2078 struct sendbundle {
2079    struct header  *sb_hp;
2080    struct name    *sb_to;
2081    FILE           *sb_input;
2082    struct str     sb_signer;  /* USER@HOST for signing+ */
2083    struct url     sb_url;
2084    struct ccred   sb_ccred;
2085 };
2086
2087 /* Structure of the hash table of ignored header fields */
2088 struct ignoretab {
2089    int         i_count;       /* Number of entries */
2090    struct ignored {
2091       struct ignored *i_link;    /* Next ignored field in bucket */
2092       char           *i_field;   /* This ignored field */
2093    }           *i_head[HSHSIZE];
2094 };
2095
2096 /* For saving the current directory and later returning */
2097 struct cw {
2098 #ifdef HAVE_FCHDIR
2099    int         cw_fd;
2100 #else
2101    char        cw_wd[PATH_MAX];
2102 #endif
2103 };
2104
2105 /*
2106  * Global variable declarations
2107  *
2108  * These become instantiated in main.c.
2109  */
2110
2111 #undef VL
2112 #ifdef n_MAIN_SOURCE
2113 # ifndef HAVE_AMALGAMATION
2114 #  define VL
2115 # else
2116 #  define VL            static
2117 # endif
2118 #else
2119 # define VL             extern
2120 #endif
2121
2122 VL int         mb_cur_max;          /* Value of MB_CUR_MAX */
2123 VL int         realscreenheight;    /* The real screen height */
2124 VL int         scrnwidth;           /* Screen width, or best guess */
2125 VL int         scrnheight;          /* Screen height/guess (4 header) */
2126
2127 VL char const  *homedir;            /* Path name of home directory */
2128 VL char const  *myname;             /* My login name */
2129 VL char const  *progname;           /* Our name */
2130 VL char const  *tempdir;            /* The temporary directory */
2131
2132 VL gid_t       group_id;            /* getgid() and getuid() */
2133 VL uid_t       user_id;
2134
2135 VL int         exit_status;         /* Exit status */
2136 VL ui32_t      options;             /* Bits of enum user_options */
2137 VL struct name *option_r_arg;       /* Argument to -r option */
2138 VL char const  **smopts;            /* sendmail(1) opts from commline */
2139 VL size_t      smopts_cnt;          /* Entries in smopts */
2140
2141 VL ui32_t      pstate;              /* Bits of enum program_state */
2142 VL size_t      noreset;             /* String resets suspended (recursive) */
2143
2144 /* XXX stylish sorting */
2145 VL int            msgCount;            /* Count of messages read in */
2146 VL struct mailbox mb;                  /* Current mailbox */
2147 VL int            image;               /* File descriptor for msg image */
2148 VL char           mailname[PATH_MAX];  /* Name of current file TODO URL/object*/
2149 VL char           displayname[80 - 40]; /* Prettyfied for display TODO URL/obj*/
2150 VL char           prevfile[PATH_MAX];  /* Name of previous file TODO URL/obj */
2151 VL char const     *account_name;       /* Current account name or NULL */
2152 VL off_t          mailsize;            /* Size of system mailbox */
2153 VL struct message *dot;                /* Pointer to current message */
2154 VL struct message *prevdot;            /* Previous current message */
2155 VL struct message *message;            /* The actual message structure */
2156 VL struct message *threadroot;         /* first threaded message */
2157 VL int            *n_msgvec;           /* Folder setmsize(), list.c res. store*/
2158
2159 VL struct ignoretab  ignore[2];        /* ignored and retained fields
2160                                         * 0 is ignore, 1 is retain */
2161 VL struct ignoretab  saveignore[2];    /* ignored and retained fields
2162                                         * on save to folder */
2163 VL struct ignoretab  allignore[2];     /* special, ignore all headers */
2164 VL struct ignoretab  fwdignore[2];     /* fields to ignore for forwarding */
2165
2166 VL struct time_current  time_current;  /* time(3); send: mail1() XXXcarrier */
2167 VL struct termios_state termios_state; /* getpassword(); see commands().. */
2168
2169 #ifdef HAVE_SSL
2170 VL enum ssl_verify_level   ssl_verify_level; /* SSL verification level */
2171 #endif
2172
2173 #ifdef HAVE_ICONV
2174 VL iconv_t     iconvd;
2175 #endif
2176
2177 VL sigjmp_buf  srbuf;
2178 VL int         interrupts;
2179 VL sighandler_type dflpipe;
2180
2181 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
2182  * TODO carrier structs instead of locals */
2183 VL char        *temporary_arg_v_store;
2184 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
2185 VL char const  *temporary_protocol_ext;
2186
2187 /* The remaining variables need initialization */
2188
2189 #ifndef HAVE_AMALGAMATION
2190 VL char const  month_names[12 + 1][4];
2191 VL char const  weekday_names[7 + 1][4];
2192
2193 VL char const  uagent[sizeof UAGENT];
2194
2195 VL uc_i const  class_char[1 + 0x7F];
2196 #endif
2197
2198 /*
2199  * Finally, let's include the function prototypes XXX embed
2200  */
2201
2202 #ifndef n_PRIVSEP_SOURCE
2203 # include "nailfuns.h"
2204 #endif
2205
2206 /* s-it-mode */