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. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *    This product includes software developed by the University of
  22  *    California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 /*
  41  * Mail -- a mail program
  42  *
  43  * Author: Kurt Shoens (UCB) March 25, 1978
  44  */
  45
  46 #include "config.h"
  47
  48 #include <sys/stat.h>
  49 #include <sys/types.h>
  50
  51 #ifdef HAVE_GETTIMEOFDAY
  52 # include <sys/time.h>
  53 #endif
  54
  55 #include <errno.h>
  56 #include <fcntl.h>
  57 #include <limits.h>
  58 #include <setjmp.h>
  59 #include <signal.h>
  60 #include <stdarg.h>
  61 #include <stdio.h>
  62 #include <stdlib.h>
  63 #include <string.h>
  64 #include <termios.h>
  65 #include <time.h>
  66 #include <unistd.h>
  67
  68 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
  69 # include <stdint.h>
  70 #else
  71 # include <inttypes.h>
  72 #endif
  73
  74 #ifdef HAVE_C90AMEND1
  75 # include <wchar.h>
  76 # include <wctype.h>
  77 #endif
  78 #ifdef HAVE_DEBUG
  79 # include <assert.h>
  80 #endif
  81 #ifdef HAVE_ICONV
  82 # include <iconv.h>
  83 #endif
  84 #ifdef HAVE_REGEX
  85 # include <regex.h>
  86 #endif
  87
  88 #ifdef HAVE_OPENSSL_MD5
  89 # include <openssl/md5.h>
  90 #endif
  91
  92 /*
  93  * Constants, some nail-specific macros
  94  */
  95
  96 #if !defined NI_MAXHOST
  97 # define NI_MAXHOST     1025
  98 #endif
  99
 100 /* TODO PATH_MAX: fixed-size buffer is always wrong (think NFS) */
 101 #ifndef PATH_MAX
 102 # ifdef MAXPATHLEN
 103 #  define PATH_MAX      MAXPATHLEN
 104 # else
 105 #  define PATH_MAX      1024        /* _XOPEN_PATH_MAX POSIX 2008/Cor 1-2013 */
 106 # endif
 107 #endif
 108
 109 #ifndef NAME_MAX
 110 # ifdef _POSIX_NAME_MAX
 111 #   define NAME_MAX     _POSIX_NAME_MAX
 112 # else
 113 #   define NAME_MAX     14
 114 # endif
 115 #endif
 116 #if NAME_MAX < 8
 117 # error NAME_MAX too small
 118 #endif
 119
 120 #ifndef STDIN_FILENO
 121 # define STDIN_FILENO   0
 122 #endif
 123 #ifndef STDOUT_FILENO
 124 # define STDOUT_FILENO  1
 125 #endif
 126 #ifndef STDERR_FILENO
 127 # define STDERR_FILENO  2
 128 #endif
 129
 130 #ifdef NSIG_MAX
 131 # undef NSIG
 132 # define NSIG           NSIG_MAX
 133 #elif !defined NSIG
 134 # define NSIG           ((sizeof(sigset_t) * 8) - 1)
 135 #endif
 136
 137 #ifdef O_CLOEXEC
 138 # define _O_CLOEXEC        O_CLOEXEC
 139 # define _CLOEXEC_SET(FD)  do {;} while(0)
 140 #else
 141 # define _O_CLOEXEC        0
 142 # define _CLOEXEC_SET(FD)  \
 143    do { (void)fcntl((FD), F_SETFD, FD_CLOEXEC); } while (0)
 144 #endif
 145
 146 /*  */
 147
 148 #if BUFSIZ + 0 > 2560               /* TODO simply use BUFSIZ? */
 149 # define LINESIZE       BUFSIZ      /* max readable line width */
 150 #else
 151 # define LINESIZE       2560
 152 #endif
 153 #define BUFFER_SIZE     (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
 154
 155 /* Network protocol newline */
 156 #define NETNL           "\015\012"
 157 #define NETLINE(X)      X NETNL
 158
 159 /* Number of Not-Yet-Dead calls that are remembered */
 160 #if defined HAVE_DEBUG || defined HAVE_DEVEL || defined HAVE_NYD2
 161 # ifdef HAVE_NYD2
 162 #  define NYD_CALLS_MAX (25 * 84)
 163 # elif defined HAVE_DEVEL
 164 #  define NYD_CALLS_MAX (25 * 42)
 165 # else
 166 #  define NYD_CALLS_MAX (25 * 10)
 167 # endif
 168 #endif
 169
 170 #define APPEND                   /* New mail goes to end of mailbox */
 171 #define CBAD            (-15555)
 172 #define ESCAPE          '~'      /* Default escape for sending */
 173 #define FIO_STACK_SIZE  20       /* Maximum recursion for sourcing */
 174 #define HIST_SIZE       242      /* tty.c: history list default size */
 175 #define HSHSIZE         23       /* Hash prime TODO make dynamic, obsolete */
 176 #define MAXARGC         1024     /* Maximum list of raw strings */
 177 #define MAXEXP          25       /* Maximum expansion of aliases */
 178 #define PROMPT_BUFFER_SIZE 80    /* getprompt() bufsize (> 3!) */
 179
 180 #define ACCOUNT_NULL    "null"   /* Name of "null" account */
 181 #define MAILRC          "~/.mailrc"
 182 #define NETRC           "~/.netrc"
 183 #define TMPDIR_FALLBACK "/tmp"
 184
 185 /* Some environment variables for pipe hooks */
 186 #define AGENT_USER      "NAIL_USER"
 187 #define AGENT_USER_ENC  "NAIL_USER_ENC"
 188 #define AGENT_HOST      "NAIL_HOST"
 189 #define AGENT_HOST_PORT "NAIL_HOST_PORT"
 190
 191 #undef COLOUR
 192 #ifdef HAVE_COLOUR
 193 # define COLOUR(X)      X
 194 #else
 195 # define COLOUR(X)
 196 #endif
 197 #define COLOUR_MSGINFO  "fg=green"
 198 #define COLOUR_PARTINFO "fg=brown"
 199 #define COLOUR_FROM_    "fg=brown"
 200 #define COLOUR_HEADER   "fg=red"
 201 #define COLOUR_UHEADER  "ft=bold,fg=red"
 202 #define COLOUR_TERMS    \
 203    "cons25,linux,rxvt,rxvt-unicode,screen,sun,vt100,vt220,wsvt25,xterm"
 204 #define COLOUR_USER_HEADERS "from,subject"
 205
 206 #define FROM_DATEBUF    64    /* Size of RFC 4155 From_ line date */
 207 #define DATE_DAYSYEAR   365L
 208 #define DATE_SECSMIN    60L
 209 #define DATE_MINSHOUR   60L
 210 #define DATE_HOURSDAY   24L
 211 #define DATE_SECSDAY    (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
 212
 213 /* *indentprefix* default as of POSIX */
 214 #define INDENT_DEFAULT  "\t"
 215
 216 /* Default *encoding* as enum mime_enc below */
 217 #define MIME_DEFAULT_ENCODING MIMEE_QP
 218
 219 /* Maximum allowed line length in a mail before QP folding is necessary), and
 220  * the real limit we go for */
 221 #define MIME_LINELEN_MAX   998   /* Plus CRLF */
 222 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 48)
 223
 224 /* Ditto, SHOULD */
 225 #define MIME_LINELEN    78    /* Plus CRLF */
 226
 227 /* And in headers which contain an encoded word according to RFC 2047 there is
 228  * yet another limit; also RFC 2045: 6.7, (5). */
 229 #define MIME_LINELEN_RFC2047 76
 230
 231 /* Locations of mime.types(5) */
 232 #define MIME_TYPES_USR  "~/.mime.types"
 233 #define MIME_TYPES_SYS  "/etc/mime.types"
 234
 235 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set */
 236 #define CHARSET_7BIT    "US-ASCII"
 237 #ifdef HAVE_ICONV
 238 # define CHARSET_8BIT      "UTF-8"
 239 # define CHARSET_8BIT_OKEY charset_8bit
 240 #else
 241 # define CHARSET_8BIT      "ISO-8859-1"
 242 # define CHARSET_8BIT_OKEY ttycharset
 243 #endif
 244
 245 /* Some environment variables for pipe hooks etc. */
 246 #define NAILENV_TMPDIR              "NAIL_TMPDIR"
 247 #define NAILENV_FILENAME            "NAIL_FILENAME"
 248 #define NAILENV_FILENAME_GENERATED  "NAIL_FILENAME_GENERATED"
 249 #define NAILENV_CONTENT             "NAIL_CONTENT"
 250 #define NAILENV_CONTENT_EVIDENCE    "NAIL_CONTENT_EVIDENCE"
 251
 252 /* Is *W* a quoting (ASCII only) character? */
 253 #define ISQUOTE(W)      \
 254    ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
 255
 256 /* Maximum number of quote characters (not bytes!) that'll be used on
 257  * follow lines when compressing leading quote characters */
 258 #define QUOTE_MAX       42
 259
 260 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
 261 #define QUOTE_TAB_SPACES 8
 262
 263 /* Maximum size of a message that is passed through to the spam system */
 264 #define SPAM_MAXSIZE    420000
 265
 266 /* String dope: dynamic buffer size, and size of the single builtin one that's
 267  * used first; note that these value include the size of the structure */
 268 #define SBUFFER_SIZE    ((0x10000u >> 1u) - 0x400)
 269 #define SBUFFER_BUILTIN (0x10000u >> 1u)
 270
 271 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
 272 #ifndef XSHELL
 273 # define XSHELL         "/bin/sh"
 274 #endif
 275 #ifndef XLISTER
 276 # define XLISTER        "ls"
 277 #endif
 278 #ifndef XPAGER
 279 # define XPAGER         "more"
 280 #endif
 281
 282 /*
 283  * OS, CC support, generic macros etc.
 284  */
 285
 286 /* OS: we're not a library, only set what needs special treatment somewhere */
 287 #define OS_DRAGONFLY    0
 288 #define OS_SOLARIS      0
 289 #define OS_SUNOS        0
 290
 291 #ifdef __DragonFly__
 292 # undef OS_DRAGONFLY
 293 # define OS_DRAGONFLY   1
 294 #elif defined __solaris__ || defined __sun
 295 # if defined __SVR4 || defined __svr4__
 296 #  undef OS_SOLARIS
 297 #  define OS_SOLARIS    1
 298 # else
 299 #  undef OS_SUNOS
 300 #  define OS_SUNOS      1
 301 # endif
 302 #endif
 303
 304 /* CC */
 305 #define CC_CLANG           0
 306 #define PREREQ_CLANG(X,Y)  0
 307 #define CC_GCC             0
 308 #define PREREQ_GCC(X,Y)    0
 309
 310 #ifdef __clang__
 311 # undef CC_CLANG
 312 # undef PREREQ_CLANG
 313 # define CC_CLANG          1
 314 # define PREREQ_CLANG(X,Y) \
 315    (__clang_major__ + 0 > (X) || \
 316     (__clang_major__ + 0 == (X) && __clang_minor__ + 0 >= (Y)))
 317 # define __EXTEN           __extension__
 318 #elif defined __GNUC__
 319 # undef CC_GCC
 320 # undef PREREQ_GCC
 321 # define CC_GCC            1
 322 # define PREREQ_GCC(X,Y)   \
 323    (__GNUC__ + 0 > (X) || (__GNUC__ + 0 == (X) && __GNUC_MINOR__ + 0 >= (Y)))
 324 # define __EXTEN           __extension__
 325 #endif
 326
 327 #ifndef __EXTEN
 328 # define __EXTEN
 329 #endif
 330
 331 /* Suppress some technical warnings via #pragma's unless developing.
 332  * XXX Wild guesses: clang(1) 1.7 and (OpenBSD) gcc(1) 4.2.1 don't work */
 333 #ifndef HAVE_DEVEL
 334 # if PREREQ_CLANG(3, 4)
 335 #  pragma clang diagnostic ignored "-Wunused-result"
 336 #  pragma clang diagnostic ignored "-Wformat"
 337 # elif PREREQ_GCC(4, 7)
 338 #  pragma GCC diagnostic ignored "-Wunused-local-typedefs"
 339 #  pragma GCC diagnostic ignored "-Wunused-result"
 340 #  pragma GCC diagnostic ignored "-Wformat"
 341 # endif
 342 #endif
 343
 344 /* For injection macros like DBG(), NATCH_CHAR() */
 345 #define COMMA           ,
 346
 347 #define EMPTY_FILE()    typedef int CONCAT(avoid_empty_file__, n_FILE);
 348
 349 /* Pointer to size_t */
 350 #define PTR2SIZE(X)     ((size_t)(uintptr_t)(X))
 351
 352 /* Pointer comparison (types from below) */
 353 #define PTRCMP(A,C,B)   ((uintptr_t)(A) C (uintptr_t)(B))
 354
 355 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
 356  * Note: doesn't sign-extend correctly, that's still up to the caller */
 357 #define UICMP(T,A,C,B)  ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
 358
 359 /* Align something to a size/boundary that cannot cause just any problem */
 360 #define ALIGN(X)        (((X) + 2*sizeof(void*)) & ~((2*sizeof(void*)) - 1))
 361
 362 /* Members in constant array */
 363 #ifndef NELEM
 364 # define NELEM(A)       (sizeof(A) / sizeof(A[0]))
 365 #endif
 366
 367 /* sizeof() for member fields */
 368 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
 369
 370 /* Casts-away (*NOT* cast-away) */
 371 #define UNUSED(X)       ((void)(X))
 372 #define UNCONST(P)      ((void*)(uintptr_t)(void const*)(P))
 373 #define UNVOLATILE(P)   ((void*)(uintptr_t)(void volatile*)(P))
 374 #define UNXXX(T,C,P)    ((T)(uintptr_t)(C)(P))
 375
 376 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
 377 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
 378 # define STRING(X)      #X
 379 # define XSTRING(X)     STRING(X)
 380 # define CONCAT(S1,S2)  _CONCAT(S1, S2)
 381 # define _CONCAT(S1,S2) S1 ## S2
 382 #else
 383 # define STRING(X)      "X"
 384 # define XSTRING        STRING
 385 # define CONCAT(S1,S2)  S1/**/S2
 386 #endif
 387
 388 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 389   /* Variable size arrays and structure fields */
 390 # define VFIELD_SIZE(X)
 391 # define VFIELD_SIZEOF(T,F) (0)
 392   /* Inline functions */
 393 # define HAVE_INLINE
 394 # define INLINE         inline
 395 # define SINLINE        static inline
 396 #else
 397 # define VFIELD_SIZE(X) \
 398   ((X) == 0 ? sizeof(size_t) \
 399    : ((ssize_t)(X) < 0 ? sizeof(size_t) - (X) : (size_t)(X)))
 400 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
 401 # if CC_CLANG || PREREQ_GCC(2, 9)
 402 #   define INLINE       static __inline
 403 #   define SINLINE      static __inline
 404 # else
 405 #   define INLINE
 406 #   define SINLINE      static
 407 # endif
 408 #endif
 409
 410 #undef __FUN__
 411 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 412 # define __FUN__        __func__
 413 #elif CC_CLANG || PREREQ_GCC(3, 4)
 414 # define __FUN__        __extension__ __FUNCTION__
 415 #else
 416 # define __FUN__        uagent   /* Something that is not a literal */
 417 #endif
 418
 419 #if defined __predict_true && defined __predict_false
 420 # define LIKELY(X)      __predict_true(X)
 421 # define UNLIKELY(X)    __predict_false(X)
 422 #elif CC_CLANG || PREREQ_GCC(2, 96)
 423 # define LIKELY(X)      __builtin_expect(X, 1)
 424 # define UNLIKELY(X)    __builtin_expect(X, 0)
 425 #else
 426 # define LIKELY(X)      (X)
 427 # define UNLIKELY(X)    (X)
 428 #endif
 429
 430 #undef HAVE_NATCH_CHAR
 431 #undef NATCH_CHAR
 432 #if defined HAVE_SETLOCALE && defined HAVE_C90AMEND1 && defined HAVE_WCWIDTH
 433 # define HAVE_NATCH_CHAR
 434 # define NATCH_CHAR(X)  X
 435 #else
 436 # define NATCH_CHAR(X)
 437 #endif
 438
 439 /* Compile-Time-Assert
 440  * Problem is that some compilers warn on unused local typedefs, so add
 441  * a special local CTA to overcome this */
 442 #define CTA(TEST)       _CTA_1(TEST, n_FILE, __LINE__)
 443 #define LCTA(TEST)      _LCTA_1(TEST, n_FILE, __LINE__)
 444
 445 #define _CTA_1(T,F,L)   _CTA_2(T, F, L)
 446 #define _CTA_2(T,F,L)  \
 447    typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1]
 448 #define _LCTA_1(T,F,L)  _LCTA_2(T, F, L)
 449 #define _LCTA_2(T,F,L) \
 450 do {\
 451    typedef char ASSERTION_failed_in_file_## F ## _at_line_ ## L[(T) ? 1 : -1];\
 452    ASSERTION_failed_in_file_## F ## _at_line_ ## L __i_am_unused__;\
 453    UNUSED(__i_am_unused__);\
 454 } while (0)
 455
 456 #undef ISPOW2
 457 #define ISPOW2(X)       ((((X) - 1) & (X)) == 0)
 458 #undef MIN
 459 #define MIN(A, B)       ((A) < (B) ? (A) : (B))
 460 #undef MAX
 461 #define MAX(A, B)       ((A) < (B) ? (B) : (A))
 462 #undef ABS
 463 #define ABS(A)          ((A) < 0 ? -(A) : (A))
 464
 465 #undef DBG
 466 #undef NDBG
 467 #ifndef HAVE_DEBUG
 468 # undef assert
 469 # define assert(X)      UNUSED(0)
 470 # define DBG(X)
 471 # define NDBG(X)        X
 472 #else
 473 # define DBG(X)         X
 474 # define NDBG(X)
 475 #endif
 476
 477 /* Translation (init in main.c) */
 478 #undef _
 479 #undef N_
 480 #undef V_
 481 #define _(S)            S
 482 #define N_(S)           S
 483 #define V_(S)           S
 484
 485 /*
 486  * Types
 487  */
 488
 489 #ifdef UINT8_MAX
 490 # define UI8_MAX        UINT8_MAX
 491 # define SI8_MIN        INT8_MIN
 492 # define SI8_MAX        INT8_MAX
 493 typedef uint8_t         ui8_t;
 494 typedef int8_t          si8_t;
 495 #elif UCHAR_MAX != 255
 496 # error UCHAR_MAX must be 255
 497 #else
 498 # define UI8_MAX        UCHAR_MAX
 499 # define SI8_MIN        CHAR_MIN
 500 # define SI8_MAX        CHAR_MAX
 501 typedef unsigned char   ui8_t;
 502 typedef signed char     si8_t;
 503 #endif
 504
 505 #if !defined PRIu8 || !defined PRId8
 506 # undef PRIu8
 507 # undef PRId8
 508 # define PRIu8          "hhu"
 509 # define PRId8          "hhd"
 510 #endif
 511
 512 #ifdef UINT16_MAX
 513 # define UI16_MAX       UINT16_MAX
 514 # define SI16_MIN       INT16_MIN
 515 # define SI16_MAX       INT16_MAX
 516 typedef uint16_t        ui16_t;
 517 typedef int16_t         si16_t;
 518 #elif USHRT_MAX != 0xFFFFu
 519 # error USHRT_MAX must be 0xFFFF
 520 #else
 521 # define UI16_MAX       USHRT_MAX
 522 # define SI16_MIN       SHRT_MIN
 523 # define SI16_MAX       SHRT_MAX
 524 typedef unsigned short  ui16_t;
 525 typedef signed short    si16_t;
 526 #endif
 527
 528 #if !defined PRIu16 || !defined PRId16
 529 # undef PRIu16
 530 # undef PRId16
 531 # if UI16_MAX == UINT_MAX
 532 #  define PRIu16        "u"
 533 #  define PRId16        "d"
 534 # else
 535 #  define PRIu16        "hu"
 536 #  define PRId16        "hd"
 537 # endif
 538 #endif
 539
 540 #ifdef UINT32_MAX
 541 # define UI32_MAX       UINT32_MAX
 542 # define SI32_MIN       INT32_MIN
 543 # define SI32_MAX       INT32_MAX
 544 typedef uint32_t        ui32_t;
 545 typedef int32_t         si32_t;
 546 #elif ULONG_MAX == 0xFFFFFFFFu
 547 # define UI32_MAX       ULONG_MAX
 548 # define SI32_MIN       LONG_MIN
 549 # define SI32_MAX       LONG_MAX
 550 typedef unsigned long int  ui32_t;
 551 typedef signed long int    si32_t;
 552 #elif UINT_MAX != 0xFFFFFFFFu
 553 # error UINT_MAX must be 0xFFFFFFFF
 554 #else
 555 # define UI32_MAX       UINT_MAX
 556 # define SI32_MIN       INT_MIN
 557 # define SI32_MAX       INT_MAX
 558 typedef unsigned int    ui32_t;
 559 typedef signed int      si32_t;
 560 #endif
 561
 562 #if !defined PRIu32 || !defined PRId32
 563 # undef PRIu32
 564 # undef PRId32
 565 # if UI32_MAX == ULONG_MAX
 566 #  define PRIu32        "lu"
 567 #  define PRId32        "ld"
 568 # else
 569 #  define PRIu32        "u"
 570 #  define PRId32        "d"
 571 # endif
 572 #endif
 573
 574 #ifdef UINT64_MAX
 575 # define UI64_MAX       UINT64_MAX
 576 # define SI64_MIN       INT64_MIN
 577 # define SI64_MAX       INT64_MAX
 578 typedef uint64_t        ui64_t;
 579 typedef int64_t         si64_t;
 580 #elif ULONG_MAX <= 0xFFFFFFFFu
 581 # if !defined ULLONG_MAX || (ULLONG_MAX >> 31) < 0xFFFFFFFFu
 582 #  error We need a 64 bit integer
 583 # else
 584 #  define UI64_MAX      ULLONG_MAX
 585 #  define SI64_MIN      LLONG_MIN
 586 #  define SI64_MAX      LLONG_MAX
 587 __EXTEN typedef unsigned long long  ui64_t;
 588 __EXTEN typedef signed long long    si64_t;
 589 # endif
 590 #else
 591 # define UI64_MAX       ULONG_MAX
 592 # define SI64_MIN       LONG_MIN
 593 # define SI64_MAX       LONG_MAX
 594 typedef unsigned long   ui64_t;
 595 typedef signed long     si64_t;
 596 #endif
 597
 598 #if !defined PRIu64 || !defined PRId64 || !defined PRIX64
 599 # undef PRIu64
 600 # undef PRId64
 601 # undef PRIX64
 602 # if defined ULLONG_MAX && UI64_MAX == ULLONG_MAX
 603 #  define PRIu64        "llu"
 604 #  define PRId64        "lld"
 605 #  define PRIX64        "llX"
 606 # else
 607 #  define PRIu64        "lu"
 608 #  define PRId64        "ld"
 609 #  define PRIX64        "lX"
 610 # endif
 611 #endif
 612
 613 /* (So that we can use UICMP() for size_t comparison, too) */
 614 typedef size_t          uiz_t;
 615 typedef ssize_t         siz_t;
 616
 617 #undef PRIuZ
 618 #undef PRIdZ
 619 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 620 # define PRIuZ          "zu"
 621 # define PRIdZ          "zd"
 622 # define PRIxZ_FMT_CTA() CTA(1 == 1)
 623 # define UIZ_MAX        SIZE_MAX
 624 #elif defined SIZE_MAX
 625   /* UnixWare has size_t as unsigned as required but uses a signed limit
 626    * constant (which is thus false!) */
 627 # if SIZE_MAX == UI64_MAX || SIZE_MAX == SI64_MAX
 628 #  define PRIuZ         PRIu64
 629 #  define PRIdZ         PRId64
 630 #  define PRIxZ_FMT_CTA() CTA(sizeof(size_t) == sizeof(ui64_t))
 631 # elif SIZE_MAX == UI32_MAX || SIZE_MAX == SI32_MAX
 632 #  define PRIuZ         PRIu32
 633 #  define PRIdZ         PRId32
 634 #  define PRIxZ_FMT_CTA() CTA(sizeof(size_t) == sizeof(ui32_t))
 635 # else
 636 #  error SIZE_MAX is neither UI64_MAX nor UI32_MAX (please report this)
 637 # endif
 638 # define UIZ_MAX        SIZE_MAX
 639 #endif
 640 #ifndef PRIuZ
 641 # define PRIuZ          "lu"
 642 # define PRIdZ          "ld"
 643 # define PRIxZ_FMT_CTA() CTA(sizeof(size_t) == sizeof(unsigned long))
 644 # define UIZ_MAX        ULONG_MAX
 645 #endif
 646
 647 #ifndef UINTPTR_MAX
 648 # ifdef SIZE_MAX
 649 #  define uintptr_t     size_t
 650 #  define UINTPTR_MAX   SIZE_MAX
 651 # else
 652 #  define uintptr_t     unsigned long
 653 #  define UINTPTR_MAX   ULONG_MAX
 654 # endif
 655 #endif
 656
 657 #if !defined PRIuPTR || !defined PRIXPTR
 658 # undef PRIuPTR
 659 # undef PRIXPTR
 660 # if UINTPTR_MAX == ULONG_MAX
 661 #  define PRIuPTR       "lu"
 662 #  define PRIXPTR       "lX"
 663 # else
 664 #  define PRIuPTR       "u"
 665 #  define PRIXPTR       "X"
 666 # endif
 667 #endif
 668
 669 enum {FAL0, TRU1, TRUM1 = -1};
 670 typedef si8_t           bool_t;
 671
 672 /* Add shorter aliases for "normal" integers */
 673 typedef unsigned long   ul_i;
 674 typedef unsigned int    ui_i;
 675 typedef unsigned short  us_i;
 676 typedef unsigned char   uc_i;
 677
 678 typedef signed long     sl_i;
 679 typedef signed int      si_i;
 680 typedef signed short    ss_i;
 681 typedef signed char     sc_i;
 682
 683 typedef void (          *sighandler_type)(int);
 684
 685 enum authtype {
 686    AUTHTYPE_NONE     = 1<<0,
 687    AUTHTYPE_PLAIN    = 1<<1,  /* POP3: APOP is covered by this */
 688    AUTHTYPE_LOGIN    = 1<<2,
 689    AUTHTYPE_CRAM_MD5 = 1<<3,
 690    AUTHTYPE_GSSAPI   = 1<<4
 691 };
 692
 693 enum expand_addr_flags {
 694    EAF_NONE       = 0,
 695    EAF_SET        = 1<<0,     /* *expandaddr* set */
 696    EAF_RESTRICT   = 1<<1,     /* "restrict" */
 697    EAF_FAIL       = 1<<2,     /* "fail" */
 698    EAF_NOALIAS    = 1<<3      /* "noalias" */
 699 };
 700
 701 enum expand_addr_check_mode {
 702    EACM_NONE      = 0,        /* Don't care about *expandaddr* */
 703    EACM_NORMAL    = 1<<0,     /* Use our normal *expandaddr* checking */
 704    EACM_STRICT    = 1<<1,     /* Never allow any file or pipe addresse */
 705    EACM_MODE_MASK = 0x3,      /* _NORMAL and _STRICT are mutual! */
 706
 707    EACM_NOALIAS   = 1<<2,     /* Don't allow MTA aliases (non-addresses) */
 708    EACM_NOLOG     = 1<<3      /* Don't log check errors */
 709 };
 710
 711 enum colourspec {
 712    COLOURSPEC_MSGINFO,
 713    COLOURSPEC_PARTINFO,
 714    COLOURSPEC_FROM_,
 715    COLOURSPEC_HEADER,
 716    COLOURSPEC_UHEADER,
 717    COLOURSPEC_RESET
 718 };
 719
 720 enum conversion {
 721    CONV_NONE,        /* no conversion */
 722    CONV_7BIT,        /* no conversion, is 7bit */
 723    CONV_FROMQP,      /* convert from quoted-printable */
 724    CONV_TOQP,        /* convert to quoted-printable */
 725    CONV_8BIT,        /* convert to 8bit (iconv) */
 726    CONV_FROMB64,     /* convert from base64 */
 727    CONV_FROMB64_T,   /* convert from base64/text */
 728    CONV_TOB64,       /* convert to base64 */
 729    CONV_FROMHDR,     /* convert from RFC1522 format */
 730    CONV_TOHDR,       /* convert to RFC1522 format */
 731    CONV_TOHDR_A      /* convert addresses for header */
 732 };
 733
 734 enum cproto {
 735    CPROTO_SMTP,
 736    CPROTO_POP3,
 737    CPROTO_IMAP
 738 };
 739
 740 enum exit_status {
 741    EXIT_OK        = EXIT_SUCCESS,
 742    EXIT_ERR       = EXIT_FAILURE,
 743    EXIT_USE       = 64,       /* sysexits.h:EX_USAGE */
 744    EXIT_COLL_ABORT = 1<<1,    /* Message collection was aborted */
 745    EXIT_SEND_ERROR = 1<<2     /* Unspecified send error occurred */
 746 };
 747
 748 enum fedit_mode {
 749    FEDIT_NONE     = 0,
 750    FEDIT_SYSBOX   = 1<<0,     /* %: prefix */
 751    FEDIT_RDONLY   = 1<<1,     /* Readonly (per-box, OPT_R_FLAG is global) */
 752    FEDIT_NEWMAIL  = 1<<2      /* `newmail' operation TODO OBSOLETE THIS! */
 753 };
 754
 755 enum fexp_mode {
 756    FEXP_FULL,                 /* Full expansion */
 757    FEXP_LOCAL     = 1<<0,     /* Result must be local file/maildir */
 758    FEXP_SHELL     = 1<<1,     /* No folder %,#,&,+ stuff, yet sh(1) */
 759    FEXP_NSHORTCUT = 1<<2,     /* Don't expand shortcuts */
 760    FEXP_SILENT    = 1<<3,     /* Don't print but only return errors */
 761    FEXP_MULTIOK   = 1<<4,     /* Expansion to many entries is ok */
 762    FEXP_NSHELL    = 1<<5      /* Don't do shell word exp. (but ~/, $VAR) */
 763 };
 764
 765 enum flock_type {
 766    FLOCK_READ,
 767    FLOCK_WRITE,
 768    FLOCK_UNLOCK
 769 };
 770
 771 enum mimecontent {
 772    MIME_UNKNOWN,     /* unknown content */
 773    MIME_SUBHDR,      /* inside a multipart subheader */
 774    MIME_822,         /* message/rfc822 content */
 775    MIME_MESSAGE,     /* other message/ content */
 776    MIME_TEXT_PLAIN,  /* text/plain content */
 777    MIME_TEXT_HTML,   /* text/html content */
 778    MIME_TEXT,        /* other text/ content */
 779    MIME_ALTERNATIVE, /* multipart/alternative content */
 780    MIME_RELATED,     /* mime/related (RFC 2387) */
 781    MIME_DIGEST,      /* multipart/digest content */
 782    MIME_MULTI,       /* other multipart/ content */
 783    MIME_PKCS7,       /* PKCS7 content */
 784    MIME_DISCARD      /* content is discarded */
 785 };
 786
 787 enum mime_counter_evidence {
 788    MIMECE_NONE,
 789    MIMECE_SET        = 1<<0,  /* *mime-counter-evidence* was set */
 790    MIMECE_BIN_OVWR   = 1<<1,  /* appli../octet-stream: check, ovw if possible */
 791    MIMECE_ALL_OVWR   = 1<<2,  /* all: check, ovw if possible */
 792    MIMECE_BIN_PARSE  = 1<<3   /* appli../octet-stream: classify contents last */
 793 };
 794
 795 /* Content-Transfer-Encodings as defined in RFC 2045:
 796  * - Quoted-Printable, section 6.7
 797  * - Base64, section 6.8 */
 798 #define QP_LINESIZE     (4 * 19)       /* Max. compliant QP linesize */
 799
 800 #define B64_LINESIZE    (4 * 19)       /* Max. compliant Base64 linesize */
 801 #define B64_ENCODE_INPUT_PER_LINE 57   /* Max. input for Base64 encode/line */
 802
 803 enum mime_enc {
 804    MIMEE_NONE,       /* message is not in MIME format */
 805    MIMEE_BIN,        /* message is in binary encoding */
 806    MIMEE_8B,         /* message is in 8bit encoding */
 807    MIMEE_7B,         /* message is in 7bit encoding */
 808    MIMEE_QP,         /* message is quoted-printable */
 809    MIMEE_B64         /* message is in base64 encoding */
 810 };
 811
 812 /* xxx QP came later, maybe rewrite all to use mime_enc_flags directly? */
 813 enum mime_enc_flags {
 814    MIMEEF_NONE,
 815    MIMEEF_SALLOC     = 1<<0,  /* Use salloc(), not srealloc().. */
 816    /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
 817    MIMEEF_BUF        = 1<<1,
 818    MIMEEF_CRLF       = 1<<2,  /* (encode) Append "\r\n" to lines */
 819    MIMEEF_LF         = 1<<3,  /* (encode) Append "\n" to lines */
 820    /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
 821     * inject the desired line-ending whenever a linewrap is desired */
 822    MIMEEF_MULTILINE  = 1<<4,
 823    /* (encode) Quote with header rules, do not generate soft NL breaks?
 824     * For mustquote(), specifies wether special RFC 2047 header rules
 825     * should be used instead */
 826    MIMEEF_ISHEAD     = 1<<5,
 827    /* (encode) Ditto; for mustquote() this furtherly fine-tunes behaviour in
 828     * that characters which would not be reported as "must-quote" when
 829     * detecting wether quoting is necessary at all will be reported as
 830     * "must-quote" if they have to be encoded in an encoded word */
 831    MIMEEF_ISENCWORD  = 1<<6,
 832    __MIMEEF_LAST     = MIMEEF_ISENCWORD
 833 };
 834
 835 enum qpflags {
 836    QP_NONE        = MIMEEF_NONE,
 837    QP_SALLOC      = MIMEEF_SALLOC,
 838    QP_BUF         = MIMEEF_BUF,
 839    QP_ISHEAD      = MIMEEF_ISHEAD,
 840    QP_ISENCWORD   = MIMEEF_ISENCWORD
 841 };
 842
 843 enum b64flags {
 844    B64_NONE       = MIMEEF_NONE,
 845    B64_SALLOC     = MIMEEF_SALLOC,
 846    B64_BUF        = MIMEEF_BUF,
 847    B64_CRLF       = MIMEEF_CRLF,
 848    B64_LF         = MIMEEF_LF,
 849    B64_MULTILINE  = MIMEEF_MULTILINE,
 850    /* Not used, but for clarity only */
 851    B64_ISHEAD     = MIMEEF_ISHEAD,
 852    B64_ISENCWORD  = MIMEEF_ISENCWORD,
 853    /* Special version of Base64, "Base64URL", according to RFC 4648.
 854     * Only supported for encoding! */
 855    B64_RFC4648URL = __MIMEEF_LAST<<1
 856 };
 857
 858 /* Special handler return values for mime_type_mimepart_handler() */
 859 #define MIME_TYPE_HANDLER_TEXT   (char*)-1
 860 #define MIME_TYPE_HANDLER_HTML   (char*)-2
 861
 862 enum mlist_state {
 863    MLIST_OTHER       = 0,     /* Normal address */
 864    MLIST_KNOWN       = 1,     /* A known `mlist' */
 865    MLIST_SUBSCRIBED  = -1     /* A `mlsubscribe'd list */
 866 };
 867
 868 enum oflags {
 869    OF_RDONLY      = 1<<0,
 870    OF_WRONLY      = 1<<1,
 871    OF_RDWR        = 1<<2,
 872    OF_APPEND      = 1<<3,
 873    OF_CREATE      = 1<<4,
 874    OF_TRUNC       = 1<<5,
 875    OF_EXCL        = 1<<6,
 876    OF_CLOEXEC     = 1<<7,
 877    OF_UNLINK      = 1<<8,     /* Only for Ftmp(): unlink(2) after creation */
 878    OF_HOLDSIGS    = 1<<9,     /* Mutual with OF_UNLINK - await Ftmp_free() */
 879    OF_REGISTER    = 1<<10     /* Register file in our file table */
 880 };
 881
 882 enum okay {
 883    STOP = 0,
 884    OKAY = 1
 885 };
 886
 887 enum okey_xlook_mode {
 888    OXM_PLAIN      = 1<<0,     /* Plain key always tested */
 889    OXM_H_P        = 1<<1,     /* Check PLAIN-.url_h_p */
 890    OXM_U_H_P      = 1<<2,     /* Check PLAIN-.url_u_h_p */
 891    OXM_ALL        = 0x7
 892 };
 893
 894 /* <0 means "stop" unless *prompt* extensions are enabled. */
 895 enum prompt_exp {
 896    PROMPT_STOP    = -1,       /* \c */
 897    /* *prompt* extensions: \$, \@ etc. */
 898    PROMPT_DOLLAR  = -2,
 899    PROMPT_AT      = -3
 900 };
 901
 902 enum protocol {
 903    PROTO_FILE,       /* refers to a local file */
 904    PROTO_POP3,       /* is a pop3 server string */
 905    PROTO_IMAP,       /* is an imap server string */
 906    PROTO_MAILDIR,    /* refers to a maildir folder */
 907    PROTO_UNKNOWN     /* unknown protocol */
 908 };
 909
 910 enum sendaction {
 911    SEND_MBOX,        /* no conversion to perform */
 912    SEND_RFC822,      /* no conversion, no From_ line */
 913    SEND_TODISP,      /* convert to displayable form */
 914    SEND_TODISP_ALL,  /* same, include all MIME parts */
 915    SEND_SHOW,        /* convert to 'show' command form */
 916    SEND_TOSRCH,      /* convert for IMAP SEARCH */
 917    SEND_TOFILE,      /* convert for saving body to a file */
 918    SEND_TOPIPE,      /* convert for pipe-content/subc. */
 919    SEND_QUOTE,       /* convert for quoting */
 920    SEND_QUOTE_ALL,   /* same, include all MIME parts */
 921    SEND_DECRYPT      /* decrypt */
 922 };
 923
 924 #ifdef HAVE_SSL
 925 enum ssl_verify_level {
 926    SSL_VERIFY_IGNORE,
 927    SSL_VERIFY_WARN,
 928    SSL_VERIFY_ASK,
 929    SSL_VERIFY_STRICT
 930 };
 931 #endif
 932
 933 enum tdflags {
 934    TD_NONE,                   /* no display conversion */
 935    TD_ISPR        = 1<<0,     /* use isprint() checks */
 936    TD_ICONV       = 1<<1,     /* use iconv() */
 937    TD_DELCTRL     = 1<<2,     /* delete control characters */
 938
 939    /*
 940     * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
 941     * enum sendaction, and may thus NOT clash with their bit range!
 942     */
 943    _TD_EOF        = 1<<14,    /* EOF seen, last round! */
 944    _TD_BUFCOPY    = 1<<15     /* Buffer may be constant, copy it */
 945 };
 946
 947 enum user_options {
 948    OPT_NONE,
 949    OPT_DEBUG      = 1u<< 0,   /* -d / *debug* */
 950    OPT_VERB       = 1u<< 1,   /* -v / *verbose* */
 951    OPT_VERBVERB   = 1u<< 2,   /* .. even more verbosity */
 952    OPT_EXISTONLY  = 1u<< 3,   /* -e */
 953    OPT_HEADERSONLY = 1u<<4,   /* -H */
 954    OPT_HEADERLIST = 1u<< 5,   /* -L */
 955    OPT_NOSRC      = 1u<< 6,   /* -n */
 956    OPT_E_FLAG     = 1u<< 7,   /* -E / *skipemptybody* */
 957    OPT_F_FLAG     = 1u<< 8,   /* -F */
 958    OPT_N_FLAG     = 1u<< 9,   /* -N / *header* */
 959    OPT_R_FLAG     = 1u<<10,   /* -R */
 960    OPT_r_FLAG     = 1u<<11,   /* -r (plus option_r_arg) */
 961    OPT_t_FLAG     = 1u<<12,   /* -t */
 962    OPT_u_FLAG     = 1u<<13,   /* -u / $USER and pw->pw_uid != getuid(2) */
 963    OPT_TILDE_FLAG = 1u<<14,   /* -~ */
 964    OPT_BATCH_FLAG = 1u<<15,   /* -# */
 965
 966    /*  */
 967    OPT_MEMDEBUG   = 1<<16,    /* *memdebug* */
 968
 969    /*  */
 970    OPT_SENDMODE   = 1u<<17,   /* Usage case forces send mode */
 971    OPT_INTERACTIVE = 1u<<18,  /* isatty(0) */
 972    OPT_TTYIN      = OPT_INTERACTIVE,
 973    OPT_TTYOUT     = 1u<<19,
 974    OPT_UNICODE    = 1u<<20,   /* We're in an UTF-8 environment */
 975
 976    /* Some easy-access shortcuts */
 977    OPT_D_V        = OPT_DEBUG | OPT_VERB,
 978    OPT_D_VV       = OPT_DEBUG | OPT_VERBVERB
 979 };
 980
 981 #define IS_TTY_SESSION() \
 982    ((options & (OPT_TTYIN | OPT_TTYOUT)) == (OPT_TTYIN | OPT_TTYOUT))
 983
 984 #define OBSOLETE(X) \
 985 do {\
 986    if (options & OPT_D_V)\
 987       fprintf(stderr, "%s: %s\n", _("Obsoletion warning"), X);\
 988 } while (0)
 989 #define OBSOLETE2(X,Y) \
 990 do {\
 991    if (options & OPT_D_V)\
 992       fprintf(stderr, "%s: %s: %s\n", _("Obsoletion warning"), X, Y);\
 993 } while (0)
 994
 995 enum program_state {
 996    PS_STARTED        = 1<< 0,       /* main.c startup code passed, functional */
 997
 998    PS_LOADING        = 1<< 1,       /* Loading user resource files, startup */
 999    PS_SOURCING       = 1<< 2,       /* Sourcing a resource file */
1000    PS_IN_LOAD        = PS_LOADING | PS_SOURCING,
1001
1002    PS_EVAL_ERROR     = 1<< 4,       /* Last evaluate() command failed */
1003
1004    PS_HOOK_NEWMAIL   = 1<< 6,
1005    PS_HOOK           = 1<< 7,
1006    PS_HOOK_MASK      = PS_HOOK_NEWMAIL | PS_HOOK,
1007
1008    PS_EDIT           = 1<< 8,       /* Current mailbox not a "system mailbox" */
1009    PS_SAW_COMMAND    = 1<< 9,       /* ..after mailbox switch */
1010
1011    PS_DID_PRINT_DOT  = 1<<16,       /* Current message has been printed */
1012
1013    PS_MSGLIST_SAW_NO = 1<<17,       /* Last *LIST saw numerics */
1014    PS_MSGLIST_DIRECT = 1<<18,       /* One msg was directly chosen by number */
1015    PS_MSGLIST_MASK   = PS_MSGLIST_SAW_NO | PS_MSGLIST_DIRECT
1016 };
1017
1018 /* A large enum with all the binary and value options a.k.a their keys.
1019  * Only the constant keys are in here, to be looked up via ok_[bv]look(),
1020  * ok_[bv]set() and ok_[bv]clear().
1021  * Note: see the comments in accmacvar.c before changing *anything* in here! */
1022 enum okeys {
1023    /* Option keys for binary options */
1024    ok_b_add_file_recipients,
1025    ok_b_allnet,
1026    ok_b_append,
1027    ok_b_ask,
1028    ok_b_askatend,
1029    ok_b_askattach,
1030    ok_b_askbcc,
1031    ok_b_askcc,
1032    ok_b_asksign,
1033    ok_b_asksub,
1034    ok_b_attachment_ask_content_description,
1035    ok_b_attachment_ask_content_disposition,
1036    ok_b_attachment_ask_content_id,
1037    ok_b_attachment_ask_content_type,
1038    ok_b_autocollapse,
1039    ok_b_autoprint,
1040    ok_b_autothread,
1041    ok_b_bang,
1042    ok_b_batch_exit_on_error,
1043    ok_b_bsdannounce,
1044    ok_b_bsdcompat,
1045    ok_b_bsdflags,
1046    ok_b_bsdheadline,
1047    ok_b_bsdmsgs,
1048    ok_b_bsdorder,
1049    ok_b_bsdset,
1050    ok_b_colour_disable,
1051    ok_b_colour_pager,
1052    ok_b_debug,                         /* {special=1} */
1053    ok_b_disconnected,
1054    ok_b_disposition_notification_send,
1055    ok_b_dot,
1056    ok_b_editalong,
1057    ok_b_editheaders,
1058    ok_b_emptybox,
1059    ok_b_emptystart,
1060    ok_b_flipr,
1061    ok_b_followup_to,
1062    ok_b_forward_as_attachment,
1063    ok_b_fullnames,
1064    ok_b_header,                        /* {special=1} */
1065    ok_b_history_gabby,
1066    ok_b_history_gabby_persist,
1067    ok_b_hold,
1068    ok_b_idna_disable,
1069    ok_b_ignore,
1070    ok_b_ignoreeof,
1071    ok_b_imap_use_starttls,
1072    ok_b_keep,
1073    ok_b_keep_content_length,
1074    ok_b_keepsave,
1075    ok_b_line_editor_disable,
1076    ok_b_markanswered,
1077    ok_b_mbox_rfc4155,
1078    ok_b_message_id_disable,
1079    ok_b_metoo,
1080    ok_b_mime_allow_text_controls,
1081    ok_b_netrc_lookup,
1082    ok_b_outfolder,
1083    ok_b_page,
1084    ok_b_piperaw,
1085    ok_b_pop3_bulk_load,
1086    ok_b_pop3_no_apop,
1087    ok_b_pop3_use_starttls,
1088    ok_b_print_all_chars,
1089    ok_b_print_alternatives,
1090    ok_b_quiet,
1091    ok_b_quote_as_attachment,
1092    ok_b_recipients_in_cc,
1093    ok_b_record_resent,
1094    ok_b_reply_in_same_charset,
1095    ok_b_rfc822_body_from_,             /* {name=rfc822-body-from_} */
1096    ok_b_save,
1097    ok_b_searchheaders,
1098    ok_b_sendcharsets_else_ttycharset,
1099    ok_b_sendwait,
1100    ok_b_showlast,
1101    ok_b_showname,
1102    ok_b_showto,
1103    ok_b_skipemptybody,                 /* {special=1} */
1104    ok_b_smime_force_encryption,
1105    ok_b_smime_no_default_ca,
1106    ok_b_smime_sign,
1107    ok_b_smtp_use_starttls,
1108    ok_b_ssl_no_default_ca,
1109    ok_b_term_ca_mode,
1110    ok_b_v15_compat,
1111    ok_b_verbose,                       /* {special=1} */
1112    ok_b_writebackedited,
1113    ok_b_memdebug,                      /* {special=1} */
1114
1115    /* Option keys for values options */
1116    ok_v_agent_shell_lookup,
1117    ok_v_attrlist,
1118    ok_v_autobcc,
1119    ok_v_autocc,
1120    ok_v_autosort,
1121    ok_v_charset_7bit,
1122    ok_v_charset_8bit,
1123    ok_v_charset_unknown_8bit,
1124    ok_v_cmd,
1125    ok_v_colour_from_,                  /* {name=colour-from_} */
1126    ok_v_colour_header,
1127    ok_v_colour_msginfo,
1128    ok_v_colour_partinfo,
1129    ok_v_colour_terms,
1130    ok_v_colour_uheader,
1131    ok_v_colour_user_headers,
1132    ok_v_crt,
1133    ok_v_datefield,
1134    ok_v_datefield_markout_older,
1135    ok_v_DEAD,
1136    ok_v_EDITOR,
1137    ok_v_encoding,
1138    ok_v_escape,
1139    ok_v_expandaddr,
1140    ok_v_expandargv,
1141    ok_v_features,                      /* {rdonly=1,virtual=_features} */
1142    ok_v_folder,                        /* {special=1} */
1143    ok_v_folder_hook,
1144    ok_v_followup_to_honour,
1145    ok_v_from,
1146    ok_v_fwdheading,
1147    ok_v_headline,
1148    ok_v_headline_bidi,
1149    ok_v_hostname,
1150    ok_v_imap_auth,
1151    ok_v_imap_cache,
1152    ok_v_imap_keepalive,
1153    ok_v_imap_list_depth,
1154    ok_v_indentprefix,
1155    ok_v_line_editor_cursor_right,      /* {special=1} */
1156    ok_v_LISTER,
1157    ok_v_MAIL,
1158    ok_v_MBOX,
1159    ok_v_mime_counter_evidence,
1160    /* TODO v15-compat: mimetypes-load-control -> mimetypes-load / mimetypes */
1161    ok_v_mimetypes_load_control,
1162    ok_v_NAIL_EXTRA_RC,                 /* {name=NAIL_EXTRA_RC} */
1163    /* TODO v15-compat: NAIL_HEAD -> message-head? */
1164    ok_v_NAIL_HEAD,                     /* {name=NAIL_HEAD} */
1165    /* TODO v15-compat: NAIL_HISTFILE -> history-file */
1166    ok_v_NAIL_HISTFILE,                 /* {name=NAIL_HISTFILE} */
1167    /* TODO v15-compat: NAIL_HISTSIZE -> history-size{,limit} */
1168    ok_v_NAIL_HISTSIZE,                 /* {name=NAIL_HISTSIZE} */
1169    /* TODO v15-compat: NAIL_TAIL -> message-tail? */
1170    ok_v_NAIL_TAIL,                     /* {name=NAIL_TAIL} */
1171    ok_v_newfolders,
1172    ok_v_newmail,
1173    ok_v_ORGANIZATION,
1174    ok_v_PAGER,
1175    ok_v_password,
1176    /* TODO pop3_auth is yet a dummy to enable easier impl. of ccred_lookup()! */
1177    ok_v_pop3_auth,
1178    ok_v_pop3_keepalive,
1179    ok_v_prompt,
1180    ok_v_quote,
1181    ok_v_quote_fold,
1182    ok_v_record,
1183    ok_v_reply_strings,
1184    ok_v_replyto,
1185    ok_v_reply_to_honour,
1186    ok_v_screen,
1187    ok_v_sendcharsets,
1188    ok_v_sender,
1189    ok_v_sendmail,
1190    ok_v_sendmail_arguments,
1191    ok_v_sendmail_progname,
1192    ok_v_SHELL,
1193    ok_v_Sign,
1194    ok_v_sign,
1195    ok_v_signature,
1196    ok_v_smime_ca_dir,
1197    ok_v_smime_ca_file,
1198    ok_v_smime_crl_dir,
1199    ok_v_smime_crl_file,
1200    ok_v_smime_sign_cert,
1201    ok_v_smime_sign_include_certs,
1202    ok_v_smtp,
1203    /* TODO v15-compat: smtp-auth: drop */
1204    ok_v_smtp_auth,
1205    ok_v_smtp_auth_password,
1206    ok_v_smtp_auth_user,
1207    ok_v_smtp_hostname,
1208    ok_v_spam_interface,
1209    ok_v_spam_maxsize,
1210    ok_v_spamc_command,
1211    ok_v_spamc_arguments,
1212    ok_v_spamc_user,
1213    ok_v_spamd_socket,
1214    ok_v_spamd_user,
1215    ok_v_spamfilter_ham,
1216    ok_v_spamfilter_noham,
1217    ok_v_spamfilter_nospam,
1218    ok_v_spamfilter_rate,
1219    ok_v_spamfilter_rate_scanscore,
1220    ok_v_spamfilter_spam,
1221    ok_v_ssl_ca_dir,
1222    ok_v_ssl_ca_file,
1223    ok_v_ssl_cert,
1224    ok_v_ssl_cipher_list,
1225    ok_v_ssl_config_file,
1226    ok_v_ssl_crl_dir,
1227    ok_v_ssl_crl_file,
1228    ok_v_ssl_key,
1229    ok_v_ssl_method,
1230    ok_v_ssl_protocol,
1231    ok_v_ssl_rand_egd,
1232    ok_v_ssl_rand_file,
1233    ok_v_ssl_verify,
1234    ok_v_stealthmua,
1235    ok_v_toplines,
1236    ok_v_ttycharset,
1237    ok_v_user,
1238    ok_v_version,                       /* {rdonly=1,virtual=VERSION} */
1239    ok_v_version_major,                 /* {rdonly=1,virtual=VERSION_MAJOR} */
1240    ok_v_version_minor,                 /* {rdonly=1,virtual=VERSION_MINOR} */
1241    ok_v_version_update,                /* {rdonly=1,virtual=VERSION_UPDATE} */
1242    ok_v_VISUAL
1243 };
1244
1245 /* Locale-independent character classes */
1246 enum {
1247    C_CNTRL        = 0000,
1248    C_BLANK        = 0001,
1249    C_WHITE        = 0002,
1250    C_SPACE        = 0004,
1251    C_PUNCT        = 0010,
1252    C_OCTAL        = 0020,
1253    C_DIGIT        = 0040,
1254    C_UPPER        = 0100,
1255    C_LOWER        = 0200
1256 };
1257
1258 struct str {
1259    char     *s;      /* the string's content */
1260    size_t   l;       /* the stings's length */
1261 };
1262
1263 struct colour_table {
1264    /* Plus a copy of *colour-user-headers* */
1265    struct str  ct_csinfo[COLOURSPEC_RESET+1 + 1];
1266 };
1267
1268 struct bidi_info {
1269    struct str  bi_start;      /* Start of (possibly) bidirectional text */
1270    struct str  bi_end;        /* End of ... */
1271    size_t      bi_pad;        /* No of visual columns to reserve for BIDI pad */
1272 };
1273
1274 struct url {
1275    char const     *url_input;       /* Input as given (really) */
1276    enum cproto    url_cproto;       /* Communication protocol as given */
1277    bool_t         url_needs_tls;    /* Wether the protocol uses SSL/TLS */
1278    bool_t         url_had_user;     /* Wether .url_user was part of the URL */
1279    ui16_t         url_portno;       /* atoi .url_port or default, host endian */
1280    char const     *url_port;        /* Port (if given) or NULL */
1281    char           url_proto[14];    /* Communication protocol as 'xy\0//' */
1282    ui8_t          url_proto_len;    /* Length of .url_proto ('\0' index) */
1283    ui8_t          url_proto_xlen;   /* .. if '\0' is replaced with ':' */
1284    struct str     url_user;         /* User, exactly as given / looked up */
1285    struct str     url_user_enc;     /* User, urlxenc()oded */
1286    struct str     url_pass;         /* Pass (urlxdec()oded) or NULL */
1287    struct str     url_host;         /* Service hostname */
1288    struct str     url_path;         /* CPROTO_IMAP: path suffix or NULL */
1289    /* TODO: url_get_component(url *, enum COMPONENT, str *store) */
1290    struct str     url_h_p;          /* .url_host[:.url_port] */
1291    /* .url_user@.url_host
1292     * Note: for CPROTO_SMTP this may resolve HOST via *smtp-hostname* (->
1293     * *hostname*)!  (And may later be overwritten according to *from*!) */
1294    struct str     url_u_h;
1295    struct str     url_u_h_p;        /* .url_user@.url_host[:.url_port] */
1296    struct str     url_eu_h_p;       /* .url_user_enc@.url_host[:.url_port] */
1297    char const     *url_p_u_h_p;     /* .url_proto://.url_u_h_p */
1298    char const     *url_p_eu_h_p;    /* .url_proto://.url_eu_h_p */
1299    char const     *url_p_eu_h_p_p;  /* .url_proto://.url_eu_h_p[/.url_path] */
1300 };
1301
1302 struct ccred {
1303    enum cproto    cc_cproto;     /* Communication protocol */
1304    enum authtype  cc_authtype;   /* Desired authentication */
1305    char const     *cc_auth;      /* Authentication type as string */
1306    struct str     cc_user;       /* User (urlxdec()oded) or NULL */
1307    struct str     cc_pass;       /* Password (urlxdec()oded) or NULL */
1308 };
1309
1310 struct time_current {
1311    time_t      tc_time;
1312    struct tm   tc_gm;
1313    struct tm   tc_local;
1314    char        tc_ctime[32];
1315 };
1316
1317 struct quoteflt {
1318    FILE        *qf_os;        /* Output stream */
1319    char const  *qf_pfix;
1320    ui32_t      qf_pfix_len;   /* Length of prefix: 0: bypass */
1321    ui32_t      qf_qfold_min;  /* Simple way: wrote prefix? */
1322 #ifdef HAVE_QUOTE_FOLD
1323    ui32_t      qf_qfold_max;  /* Otherwise: line lengths */
1324    ui8_t       qf_state;      /* *quote-fold* state machine */
1325    bool_t      qf_brk_isws;   /* Breakpoint is at WS */
1326    ui8_t       __dummy[2];
1327    ui32_t      qf_wscnt;      /* Whitespace count */
1328    ui32_t      qf_brkl;       /* Breakpoint */
1329    ui32_t      qf_brkw;       /* Visual width, breakpoint */
1330    ui32_t      qf_datw;       /* Current visual output line width */
1331    struct str  qf_dat;        /* Current visual output line */
1332    struct str  qf_currq;      /* Current quote, compressed */
1333    mbstate_t   qf_mbps[2];
1334 #endif
1335 };
1336
1337 #ifdef HAVE_FILTER_HTML_TAGSOUP
1338 struct htmlflt {
1339    FILE        *hf_os;        /* Output stream */
1340    ui32_t      hf_flags;
1341    ui32_t      hf_lmax;       /* Maximum byte +1 in .hf_line/4 */
1342    ui32_t      hf_len;        /* Current bytes in .hf_line */
1343    ui32_t      hf_last_ws;    /* Last whitespace on line (fold purposes) */
1344    ui32_t      hf_mboff;      /* Last offset for "mbtowc" */
1345    ui32_t      hf_mbwidth;    /* We count characters not bytes if possible */
1346    char        *hf_line;      /* Output line buffer - MUST be last field! */
1347    si32_t      hf_href_dist;  /* Count of lines since last HREF flush */
1348    ui32_t      hf_href_no;    /* HREF sequence number */
1349    struct htmlflt_href *hf_hrefs;
1350    struct htmlflt_tag const *hf_ign_tag; /* Tag that will end ignore mode */
1351    char        *hf_curr;      /* Current cursor into .hf_bdat */
1352    char        *hf_bmax;      /* Maximum byte in .hf_bdat +1 */
1353    char        *hf_bdat;      /* (Temporary) Tag content data storage */
1354 };
1355 #endif
1356
1357 struct search_expr {
1358    char const  *ss_where;     /* ..to search for the expr. (not always used) */
1359    char const  *ss_sexpr;     /* String search expr.; NULL: use .ss_regex */
1360 #ifdef HAVE_REGEX
1361    regex_t     ss_regex;
1362 #endif
1363 };
1364
1365 struct eval_ctx {
1366    struct str  ev_line;          /* The terminated data to evaluate */
1367    ui32_t      ev_line_size;     /* May be used to store line memory size */
1368    bool_t      ev_is_recursive;  /* Evaluation in evaluation? (collect ~:) */
1369    ui8_t       __dummy[3];
1370    bool_t      ev_add_history;   /* Enter (final) command in history? */
1371    char const  *ev_new_content;  /* History: reenter line, start with this */
1372 };
1373
1374 struct termios_state {
1375    struct termios ts_tios;
1376    char        *ts_linebuf;
1377    size_t      ts_linesize;
1378    bool_t      ts_needs_reset;
1379 };
1380
1381 #define termios_state_reset() \
1382 do {\
1383    if (termios_state.ts_needs_reset) {\
1384       tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
1385       termios_state.ts_needs_reset = FAL0;\
1386    }\
1387 } while (0)
1388
1389 struct sock {                 /* data associated with a socket */
1390    int         s_fd;          /* file descriptor */
1391 #ifdef HAVE_SSL
1392    int         s_use_ssl;     /* SSL is used */
1393 # ifdef HAVE_OPENSSL
1394    void        *s_ssl;        /* SSL object */
1395 # endif
1396 #endif
1397    char        *s_wbuf;       /* for buffered writes */
1398    int         s_wbufsize;    /* allocated size of s_buf */
1399    int         s_wbufpos;     /* position of first empty data byte */
1400    char        *s_rbufptr;    /* read pointer to s_rbuf */
1401    int         s_rsz;         /* size of last read in s_rbuf */
1402    char const  *s_desc;       /* description of error messages */
1403    void        (*s_onclose)(void);     /* execute on close */
1404    char        s_rbuf[LINESIZE + 1];   /* for buffered reads */
1405 };
1406
1407 struct sockconn {
1408    struct url     sc_url;
1409    struct ccred   sc_cred;
1410    struct sock    sc_sock;
1411 };
1412
1413 struct mailbox {
1414    enum {
1415       MB_NONE     = 000,      /* no reply expected */
1416       MB_COMD     = 001,      /* command reply expected */
1417       MB_MULT     = 002,      /* multiline reply expected */
1418       MB_PREAUTH  = 004,      /* not in authenticated state */
1419       MB_BYE      = 010       /* may accept a BYE state */
1420    }           mb_active;
1421    FILE        *mb_itf;       /* temp file with messages, read open */
1422    FILE        *mb_otf;       /* same, write open */
1423    char        *mb_sorted;    /* sort method */
1424    enum {
1425       MB_VOID,       /* no type (e. g. connection failed) */
1426       MB_FILE,       /* local file */
1427       MB_POP3,       /* POP3 mailbox */
1428       MB_IMAP,       /* IMAP mailbox */
1429       MB_MAILDIR,    /* maildir folder */
1430       MB_CACHE       /* cached mailbox */
1431    }           mb_type;       /* type of mailbox */
1432    enum {
1433       MB_DELE = 01,  /* may delete messages in mailbox */
1434       MB_EDIT = 02   /* may edit messages in mailbox */
1435    }           mb_perm;
1436    int mb_threaded;           /* mailbox has been threaded */
1437 #ifdef HAVE_IMAP
1438    enum mbflags {
1439       MB_NOFLAGS  = 000,
1440       MB_UIDPLUS  = 001 /* supports IMAP UIDPLUS */
1441    }           mb_flags;
1442    unsigned long  mb_uidvalidity;   /* IMAP unique identifier validity */
1443    char        *mb_imap_account;    /* name of current IMAP account */
1444    char        *mb_imap_pass;       /* xxx v15-compat URL workaround */
1445    char        *mb_imap_mailbox;    /* name of current IMAP mailbox */
1446    char        *mb_cache_directory; /* name of cache directory */
1447 #endif
1448    struct sock mb_sock;       /* socket structure */
1449 };
1450
1451 enum needspec {
1452    NEED_UNSPEC,      /* unspecified need, don't fetch */
1453    NEED_HEADER,      /* need the header of a message */
1454    NEED_BODY         /* need header and body of a message */
1455 };
1456
1457 enum havespec {
1458    HAVE_NOTHING,              /* nothing downloaded yet */
1459    HAVE_HEADER    = 01,       /* header is downloaded */
1460    HAVE_BODY      = 02        /* entire message is downloaded */
1461 };
1462
1463 /* flag bits. Attention: Flags that are used in cache.c may not change */
1464 enum mflag {
1465    MUSED          = (1<< 0),  /* entry is used, but this bit isn't */
1466    MDELETED       = (1<< 1),  /* entry has been deleted */
1467    MSAVED         = (1<< 2),  /* entry has been saved */
1468    MTOUCH         = (1<< 3),  /* entry has been noticed */
1469    MPRESERVE      = (1<< 4),  /* keep entry in sys mailbox */
1470    MMARK          = (1<< 5),  /* message is marked! */
1471    MODIFY         = (1<< 6),  /* message has been modified */
1472    MNEW           = (1<< 7),  /* message has never been seen */
1473    MREAD          = (1<< 8),  /* message has been read sometime. */
1474    MSTATUS        = (1<< 9),  /* message status has changed */
1475    MBOX           = (1<<10),  /* Send this to mbox, regardless */
1476    MNOFROM        = (1<<11),  /* no From line */
1477    MHIDDEN        = (1<<12),  /* message is hidden to user */
1478    MFULLYCACHED   = (1<<13),  /* message is completely cached */
1479    MBOXED         = (1<<14),  /* message has been sent to mbox */
1480    MUNLINKED      = (1<<15),  /* message was unlinked from cache */
1481    MNEWEST        = (1<<16),  /* message is very new (newmail) */
1482    MFLAG          = (1<<17),  /* message has been flagged recently */
1483    MUNFLAG        = (1<<18),  /* message has been unflagged */
1484    MFLAGGED       = (1<<19),  /* message is `flagged' */
1485    MANSWER        = (1<<20),  /* message has been answered recently */
1486    MUNANSWER      = (1<<21),  /* message has been unanswered */
1487    MANSWERED      = (1<<22),  /* message is `answered' */
1488    MDRAFT         = (1<<23),  /* message has been drafted recently */
1489    MUNDRAFT       = (1<<24),  /* message has been undrafted */
1490    MDRAFTED       = (1<<25),  /* message is marked as `draft' */
1491    MOLDMARK       = (1<<26),  /* messages was marked previously */
1492    MSPAM          = (1<<27),  /* message is classified as spam */
1493    MSPAMUNSURE    = (1<<28)   /* message may be spam, but it is unsure */
1494 };
1495 #define MMNORM          (MDELETED | MSAVED | MHIDDEN)
1496 #define MMNDEL          (MDELETED | MHIDDEN)
1497
1498 #define visible(mp)     (((mp)->m_flag & MMNDEL) == 0)
1499
1500 struct mimepart {
1501    enum mflag  m_flag;        /* flags */
1502    enum havespec m_have;      /* downloaded parts of the part */
1503 #ifdef HAVE_SPAM
1504    ui32_t      m_spamscore;   /* Spam score as int, 24:8 bits */
1505 #endif
1506    int         m_block;       /* block number of this part */
1507    size_t      m_offset;      /* offset in block of part */
1508    size_t      m_size;        /* Bytes in the part */
1509    size_t      m_xsize;       /* Bytes in the full part */
1510    long        m_lines;       /* Lines in the message */
1511    long        m_xlines;      /* Lines in the full message */
1512    time_t      m_time;        /* time the message was sent */
1513    char const  *m_from;       /* message sender */
1514    struct mimepart *m_nextpart;     /* next part at same level */
1515    struct mimepart *m_multipart;    /* parts of multipart */
1516    struct mimepart *m_parent;       /* enclosing multipart part */
1517    char const  *m_ct_type;          /* content-type */
1518    char const  *m_ct_type_plain;    /* content-type without specs */
1519    char const  *m_ct_type_usr_ovwr; /* Forcefully overwritten one */
1520    enum mimecontent m_mimecontent;  /* same in enum */
1521    char const  *m_charset;    /* charset */
1522    char const  *m_ct_enc;     /* content-transfer-encoding */
1523    enum mime_enc m_mime_enc;     /* same in enum */
1524    char        *m_partstring; /* part level string */
1525    char        *m_filename;   /* attachment filename */
1526 };
1527
1528 struct message {
1529    enum mflag  m_flag;        /* flags */
1530    enum havespec m_have;      /* downloaded parts of the message */
1531 #ifdef HAVE_SPAM
1532    ui32_t      m_spamscore;   /* Spam score as int, 24:8 bits */
1533 #endif
1534    int         m_block;       /* block number of this message */
1535    size_t      m_offset;      /* offset in block of message */
1536    size_t      m_size;        /* Bytes in the message */
1537    size_t      m_xsize;       /* Bytes in the full message */
1538    long        m_lines;       /* Lines in the message */
1539    long        m_xlines;      /* Lines in the full message */
1540    time_t      m_time;        /* time the message was sent */
1541    time_t      m_date;        /* time in the 'Date' field */
1542    unsigned    m_idhash;      /* hash on Message-ID for threads */
1543    struct message *m_child;   /* first child of this message */
1544    struct message *m_younger; /* younger brother of this message */
1545    struct message *m_elder;   /* elder brother of this message */
1546    struct message *m_parent;  /* parent of this message */
1547    unsigned    m_level;       /* thread level of message */
1548    long        m_threadpos;   /* position in threaded display */
1549 #ifdef HAVE_IMAP
1550    unsigned long m_uid;       /* IMAP unique identifier */
1551 #endif
1552    char        *m_maildir_file;  /* original maildir file of msg */
1553    ui32_t      m_maildir_hash;   /* hash of file name in maildir sub */
1554    int         m_collapsed;      /* collapsed thread information */
1555 };
1556
1557 /* Given a file address, determine the block number it represents */
1558 #define mailx_blockof(off)                ((int) ((off) / 4096))
1559 #define mailx_offsetof(off)               ((int) ((off) % 4096))
1560 #define mailx_positionof(block, offset)   ((off_t)(block) * 4096 + (offset))
1561
1562 /* Argument types */
1563 enum argtype {
1564    ARG_MSGLIST    = 0,        /* Message list type */
1565    ARG_STRLIST    = 1,        /* A pure string */
1566    ARG_RAWLIST    = 2,        /* Shell string list */
1567    ARG_NOLIST     = 3,        /* Just plain 0 */
1568    ARG_NDMLIST    = 4,        /* Message list, no defaults */
1569    ARG_ECHOLIST   = 5,        /* Like raw list, but keep quote chars */
1570    ARG_ARGMASK    = 7,        /* Mask of the above */
1571
1572    ARG_A          = 1u<< 4,   /* Needs an active mailbox */
1573    ARG_F          = 1u<< 5,   /* Is a conditional command */
1574    ARG_H          = 1u<< 6,   /* Never place in history */
1575    ARG_I          = 1u<< 7,   /* Interactive command bit */
1576    ARG_M          = 1u<< 8,   /* Legal from send mode bit */
1577    ARG_P          = 1u<< 9,   /* Autoprint dot after command */
1578    ARG_R          = 1u<<10,   /* Cannot be called from collect / recursion */
1579    ARG_T          = 1u<<11,   /* Is a transparent command */
1580    ARG_V          = 1u<<12,   /* Places data in temporary_arg_v_store */
1581    ARG_W          = 1u<<13,   /* Invalid when read only bit */
1582    ARG_O          = 1u<<14    /* OBSOLETE()d command */
1583 };
1584
1585 enum gfield {
1586    GTO            = 1<< 0,    /* Grab To: line */
1587    GSUBJECT       = 1<< 1,    /* Likewise, Subject: line */
1588    GCC            = 1<< 2,    /* And the Cc: line */
1589    GBCC           = 1<< 3,    /* And also the Bcc: line */
1590
1591    GNL            = 1<< 4,    /* Print blank line after */
1592    GDEL           = 1<< 5,    /* Entity removed from list */
1593    GCOMMA         = 1<< 6,    /* detract puts in commas */
1594    GUA            = 1<< 7,    /* User-Agent field */
1595    GMIME          = 1<< 8,    /* MIME 1.0 fields */
1596    GMSGID         = 1<< 9,    /* a Message-ID */
1597
1598    GIDENT         = 1<<11,    /* From:, Reply-To:, Organization:, MFT: field */
1599    GREF           = 1<<12,    /* References: field */
1600    GDATE          = 1<<13,    /* Date: field */
1601    GFULL          = 1<<14,    /* Include full names, comments etc. */
1602    GSKIN          = 1<<15,    /* Skin names */
1603    GEXTRA         = 1<<16,    /* Extra fields (mostly like GIDENT XXX) */
1604    GFILES         = 1<<17,    /* Include filename and pipe addresses */
1605    GFULLEXTRA     = 1<<18     /* Only with GFULL: GFULL less address */
1606 };
1607 #define GMASK           (GTO | GSUBJECT | GCC | GBCC)
1608
1609 enum header_flags {
1610    HF_NONE        = 0,
1611    HF_LIST_REPLY  = 1<< 0,
1612    HF_MFT_SENDER  = 1<< 1,    /* Add ourselves to Mail-Followup-To: */
1613    HF_RECIPIENT_RECORD = 1<<10, /* Save message in file named after rec. */
1614    HF__NEXT_SHIFT = 11
1615 };
1616
1617 /* Structure used to pass about the current state of a message (header) */
1618 struct header {
1619    ui32_t      h_flags;       /* enum header_flags bits */
1620    ui32_t      h_dummy;
1621    struct name *h_to;         /* Dynamic "To:" string */
1622    char        *h_subject;    /* Subject string */
1623    struct name *h_cc;         /* Carbon copies string */
1624    struct name *h_bcc;        /* Blind carbon copies */
1625    struct name *h_ref;        /* References */
1626    struct attachment *h_attach; /* MIME attachments */
1627    char        *h_charset;    /* preferred charset */
1628    struct name *h_from;       /* overridden "From:" field */
1629    struct name *h_sender;     /* overridden "Sender:" field */
1630    struct name *h_replyto;    /* overridden "Reply-To:" field */
1631    struct name *h_mft;        /* Mail-Followup-To */
1632    char const  *h_list_post;  /* Address from List-Post:, for `Lreply' */
1633    char        *h_organization; /* overridden "Organization:" field */
1634 };
1635
1636 /* Handling of namelist nodes used in processing the recipients of mail and
1637  * aliases, inspection of mail-addresses and all that kind of stuff */
1638 enum nameflags {
1639    NAME_NAME_SALLOC        = 1<< 0, /* .n_name is doped */
1640    NAME_FULLNAME_SALLOC    = 1<< 1, /* .n_fullname is doped */
1641    NAME_SKINNED            = 1<< 2, /* Is actually skin()ned */
1642    NAME_IDNA               = 1<< 3, /* IDNA was applied */
1643
1644    NAME_ADDRSPEC_CHECKED   = 1<< 4, /* Address has been .. and */
1645    NAME_ADDRSPEC_ISFILE    = 1<< 5, /* ..is a file path */
1646    NAME_ADDRSPEC_ISPIPE    = 1<< 6, /* ..is a command for piping */
1647    NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
1648    NAME_ADDRSPEC_ISMAIL    = 1<< 7, /* ..is a valid mail address */
1649
1650    NAME_ADDRSPEC_ERR_EMPTY = 1<< 8, /* An empty string (or NULL) */
1651    NAME_ADDRSPEC_ERR_ATSEQ = 1<< 9, /* Weird @ sequence */
1652    NAME_ADDRSPEC_ERR_CHAR  = 1<<10, /* Invalid character */
1653    NAME_ADDRSPEC_ERR_IDNA  = 1<<11, /* IDNA convertion failed */
1654    NAME_ADDRSPEC_INVALID   = NAME_ADDRSPEC_ERR_EMPTY |
1655          NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
1656          NAME_ADDRSPEC_ERR_IDNA,
1657
1658    /* Error storage (we must fit in 31-bit) */
1659    _NAME_SHIFTWC  = 12,
1660    _NAME_MAXWC    = 0x7FFFF,
1661    _NAME_MASKWC   = _NAME_MAXWC << _NAME_SHIFTWC
1662 };
1663
1664 /* In the !_ERR_EMPTY case, the failing character can be queried */
1665 #define NAME_ADDRSPEC_ERR_GETWC(F)  \
1666    ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1667 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1668 do {\
1669    (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1670          (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1671 } while (0)
1672
1673 struct name {
1674    struct name *n_flink;      /* Forward link in list. */
1675    struct name *n_blink;      /* Backward list link */
1676    enum gfield n_type;        /* From which list it came */
1677    enum nameflags n_flags;    /* enum nameflags */
1678    char        *n_name;       /* This fella's address */
1679    char        *n_fullname;   /* Ditto, unless GFULL including comment */
1680    char        *n_fullextra;  /* GFULL, without address */
1681 };
1682
1683 struct addrguts {
1684    char const  *ag_input;     /* Input string as given */
1685    size_t      ag_ilen;       /* strlen() of input */
1686    size_t      ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
1687    size_t      ag_iaddr_aend; /* ..and one past its end */
1688    char        *ag_skinned;   /* Output (alloced if !=.ag_input) */
1689    size_t      ag_slen;       /* strlen() of .ag_skinned */
1690    size_t      ag_sdom_start; /* Start of domain in .ag_skinned, */
1691    enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
1692 };
1693
1694 /* MIME attachments */
1695 enum attach_conv {
1696    AC_DEFAULT,       /* _get_lc() -> _iter_*() */
1697    AC_FIX_OUTCS,     /* _get_lc() -> "charset=" .a_charset */
1698    AC_FIX_INCS,      /* "charset=".a_input_charset (nocnv) */
1699    AC_TMPFILE        /* attachment.a_tmpf is converted */
1700 };
1701
1702 struct attachment {
1703    struct attachment *a_flink;   /* Forward link in list. */
1704    struct attachment *a_blink;   /* Backward list link */
1705    char const  *a_name;       /* file name */
1706    char const  *a_content_type;  /* content type */
1707    char const  *a_content_disposition; /* content disposition */
1708    char const  *a_content_id; /* content id */
1709    char const  *a_content_description; /* content description */
1710    char const  *a_input_charset; /* Interpretation depends on .a_conv */
1711    char const  *a_charset;    /* ... */
1712    FILE        *a_tmpf;       /* If AC_TMPFILE */
1713    enum attach_conv a_conv;   /* User chosen conversion */
1714    int         a_msgno;       /* message number */
1715 };
1716
1717 struct sendbundle {
1718    struct header  *sb_hp;
1719    struct name    *sb_to;
1720    FILE           *sb_input;
1721    struct str     sb_signer;  /* USER@HOST for signing+ */
1722    struct url     sb_url;
1723    struct ccred   sb_ccred;
1724 };
1725
1726 /* Structure of the hash table of ignored header fields */
1727 struct ignoretab {
1728    int         i_count;       /* Number of entries */
1729    struct ignored {
1730       struct ignored *i_link;    /* Next ignored field in bucket */
1731       char           *i_field;   /* This ignored field */
1732    }           *i_head[HSHSIZE];
1733 };
1734
1735 /* For saving the current directory and later returning */
1736 struct cw {
1737 #ifdef HAVE_FCHDIR
1738    int         cw_fd;
1739 #else
1740    char        cw_wd[PATH_MAX];
1741 #endif
1742 };
1743
1744 /*
1745  * Global variable declarations
1746  *
1747  * These become instantiated in main.c.
1748  */
1749
1750 #undef VL
1751 #ifdef _MAIN_SOURCE
1752 # ifndef HAVE_AMALGAMATION
1753 #  define VL
1754 # else
1755 #  define VL            static
1756 # endif
1757 #else
1758 # define VL             extern
1759 #endif
1760
1761 VL gid_t       effectivegid;        /* Saved from when we started up */
1762 VL gid_t       realgid;             /* Saved from when we started up */
1763
1764 VL int         mb_cur_max;          /* Value of MB_CUR_MAX */
1765 VL int         realscreenheight;    /* The real screen height */
1766 VL int         scrnwidth;           /* Screen width, or best guess */
1767 VL int         scrnheight;          /* Screen height/guess (4 header) */
1768 VL int         enc_has_state;       /* Encoding has shift states */
1769
1770 VL char const  *homedir;            /* Path name of home directory */
1771 VL char const  *myname;             /* My login name */
1772 VL char const  *progname;           /* Our name */
1773 VL char const  *tempdir;            /* The temporary directory */
1774
1775 VL int         exit_status;         /* Exit status */
1776 VL ui32_t      options;             /* Bits of enum user_options */
1777 VL struct name *option_r_arg;       /* Argument to -r option */
1778 VL char const  **smopts;            /* sendmail(1) opts from commline */
1779 VL size_t      smopts_count;        /* Entries in smopts */
1780
1781 VL ui32_t      pstate;              /* Bits of enum program_state */
1782 VL size_t      noreset;             /* String resets suspended (recursive) */
1783
1784 /* XXX stylish sorting */
1785 VL int            msgCount;            /* Count of messages read in */
1786 VL struct mailbox mb;                  /* Current mailbox */
1787 VL int            image;               /* File descriptor for msg image */
1788 VL char           mailname[PATH_MAX];  /* Name of current file TODO URL/object*/
1789 VL char           displayname[80 - 40]; /* Prettyfied for display TODO URL/obj*/
1790 VL char           prevfile[PATH_MAX];  /* Name of previous file TODO URL/obj */
1791 VL char const     *account_name;       /* Current account name or NULL */
1792 VL off_t          mailsize;            /* Size of system mailbox */
1793 VL struct message *dot;                /* Pointer to current message */
1794 VL struct message *prevdot;            /* Previous current message */
1795 VL struct message *message;            /* The actual message structure */
1796 VL struct message *threadroot;         /* first threaded message */
1797 VL int            imap_created_mailbox; /* hack to get feedback from imap */
1798
1799 VL struct ignoretab  ignore[2];        /* ignored and retained fields
1800                                         * 0 is ignore, 1 is retain */
1801 VL struct ignoretab  saveignore[2];    /* ignored and retained fields
1802                                         * on save to folder */
1803 VL struct ignoretab  allignore[2];     /* special, ignore all headers */
1804 VL struct ignoretab  fwdignore[2];     /* fields to ignore for forwarding */
1805
1806 VL struct time_current  time_current;  /* time(3); send: mail1() XXXcarrier */
1807 VL struct termios_state termios_state; /* getpassword(); see commands().. */
1808
1809 #ifdef HAVE_COLOUR
1810 VL struct colour_table  *colour_table;
1811 #endif
1812
1813 #ifdef HAVE_SSL
1814 VL enum ssl_verify_level   ssl_verify_level; /* SSL verification level */
1815 #endif
1816
1817 #ifdef HAVE_ICONV
1818 VL iconv_t     iconvd;
1819 #endif
1820
1821 VL sigjmp_buf  srbuf;
1822 VL int         interrupts;
1823 VL sighandler_type dflpipe;
1824 VL sighandler_type handlerstacktop;
1825 #define handlerpush(f)  (savedtop = handlerstacktop, handlerstacktop = (f))
1826 #define handlerpop()    (handlerstacktop = savedtop)
1827
1828 /* TODO Temporary hacks unless the codebase doesn't jump and uses pass-by-value
1829  * TODO carrier structs instead of locals */
1830 VL char        *temporary_arg_v_store;
1831 VL void        *temporary_localopts_store;
1832 /* TODO temporary storage to overcome which_protocol() mess (for PROTO_FILE) */
1833 VL char const  *temporary_protocol_ext;
1834
1835 /* The remaining variables need initialization */
1836
1837 #ifndef HAVE_AMALGAMATION
1838 VL char const  month_names[12 + 1][4];
1839 VL char const  weekday_names[7 + 1][4];
1840
1841 VL char const  uagent[];            /* User agent */
1842
1843 VL uc_i const  class_char[];
1844 #endif
1845
1846 /*
1847  * Finally, let's include the function prototypes XXX embed
1848  */
1849
1850 #include "nailfuns.h"
1851
1852 /* s-it-mode */