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