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