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