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 - 2014 Steffen "Daode" Nurpmeso <sdaoden@users.sf.net>.
   6  */
   7 /*
   8  * Copyright (c) 1980, 1993
   9  * The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *    This product includes software developed by the University of
  22  *    California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 /*
  41  * Mail -- a mail program
  42  *
  43  * Author: Kurt Shoens (UCB) March 25, 1978
  44  */
  45
  46 #include "config.h"
  47
  48 #include <sys/stat.h>
  49 #include <sys/types.h>
  50
  51 #include <errno.h>
  52 #include <limits.h>
  53 #include <setjmp.h>
  54 #include <signal.h>
  55 #include <stdarg.h>
  56 #include <stdio.h>
  57 #include <stdlib.h>
  58 #include <string.h>
  59 #include <termios.h>
  60 #include <time.h>
  61 #include <unistd.h>
  62
  63 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
  64 # include <stdint.h>
  65 #else
  66 # include <inttypes.h>
  67 #endif
  68
  69 #ifdef HAVE_DEBUG
  70 # include <assert.h>
  71 #endif
  72 #ifdef HAVE_ICONV
  73 # include <iconv.h>
  74 #endif
  75 #ifdef HAVE_C90AMEND1
  76 # include <wchar.h>
  77 # include <wctype.h>
  78 #endif
  79
  80 /*
  81  * Constants, some nail-specific macros
  82  */
  83
  84 #if !defined NI_MAXHOST || NI_MAXHOST < 1025
  85 # undef NI_MAXHOST
  86 # define NI_MAXHOST     1025
  87 #endif
  88
  89 #ifndef MAXPATHLEN
  90 # ifdef PATH_MAX
  91 #  define MAXPATHLEN    PATH_MAX
  92 # else
  93 #  define MAXPATHLEN    1024
  94 # endif
  95 #elif defined PATH_MAX && MAXPATHLEN < PATH_MAX
  96 # undef MAXPATHLEN
  97 # define MAXPATHLEN     PATH_MAX
  98 #endif
  99
 100 #ifndef STDIN_FILENO
 101 # define STDIN_FILENO   0
 102 #endif
 103 #ifndef STDOUT_FILENO
 104 # define STDOUT_FILENO  1
 105 #endif
 106 #ifndef STDERR_FILENO
 107 # define STDERR_FILENO  2
 108 #endif
 109
 110 #ifdef NSIG_MAX
 111 # undef NSIG
 112 # define NSIG           NSIG_MAX
 113 #elif !defined NSIG
 114 # define NSIG           ((sizeof(sigset_t) * 8) - 1)
 115 #endif
 116
 117 /*  */
 118
 119 #if BUFSIZ > 2560                   /* TODO simply use BUFSIZ? */
 120 # define LINESIZE       BUFSIZ      /* max readable line width */
 121 #else
 122 # define LINESIZE       2560
 123 #endif
 124 #define BUFFER_SIZE     (BUFSIZ >= (1u << 13) ? BUFSIZ : (1u << 14))
 125
 126 #define CBAD            (-15555)
 127 #define APPEND                   /* New mail goes to end of mailbox */
 128 #define ESCAPE          '~'      /* Default escape for sending */
 129 #define HIST_SIZE       242      /* tty.c: history list default size */
 130 #define HSHSIZE         23       /* Hash prime (aliases, vars, macros) */
 131 #define MAXARGC         1024     /* Maximum list of raw strings */
 132 #define MAXEXP          25       /* Maximum expansion of aliases */
 133 #define PROMPT_BUFFER_SIZE 80    /* getprompt() bufsize (> 3!) */
 134
 135 #define ACCOUNT_NULL    "null"   /* Name of "null" account */
 136 #define MAILRC          "~/.mailrc"
 137 #define TMPDIR_FALLBACK "/tmp"
 138
 139 #define COLOUR_MSGINFO  "fg=green"
 140 #define COLOUR_PARTINFO "fg=brown"
 141 #define COLOUR_FROM_    "fg=brown"
 142 #define COLOUR_HEADER   "fg=red"
 143 #define COLOUR_UHEADER  "ft=bold,fg=red"
 144 #define COLOUR_PAGERS   "less"
 145 #define COLOUR_TERMS    \
 146    "cons25,linux,rxvt,rxvt-unicode,sun,vt100,vt220,wsvt25,xterm,xterm-color"
 147 #define COLOUR_USER_HEADERS "from,subject"
 148
 149 #define FROM_DATEBUF    64    /* Size of RFC 4155 From_ line date */
 150 #define DATE_DAYSYEAR   365L
 151 #define DATE_SECSMIN    60L
 152 #define DATE_MINSHOUR   60L
 153 #define DATE_HOURSDAY   24L
 154 #define DATE_SECSDAY    (DATE_SECSMIN * DATE_MINSHOUR * DATE_HOURSDAY)
 155
 156 /* Default *encoding* as enum conversion below */
 157 #define MIME_DEFAULT_ENCODING CONV_TOQP
 158
 159 /* Maximum allowed line length in a mail before QP folding is necessary), and
 160  * the real limit we go for */
 161 #define MIME_LINELEN_MAX   1000
 162 #define MIME_LINELEN_LIMIT (MIME_LINELEN_MAX - 50)
 163
 164 /* Locations of mime.types(5) */
 165 #define MIME_TYPES_USR  "~/.mime.types"
 166 #define MIME_TYPES_SYS  "/etc/mime.types"
 167
 168 /* Fallback MIME charsets, if *charset-7bit* and *charset-8bit* or not set */
 169 #define CHARSET_7BIT    "US-ASCII"
 170 #ifdef HAVE_ICONV
 171 # define CHARSET_8BIT      "UTF-8"
 172 # define CHARSET_8BIT_OKEY charset_8bit
 173 #else
 174 # define CHARSET_8BIT      "ISO-8859-1"
 175 # define CHARSET_8BIT_OKEY ttycharset
 176 #endif
 177
 178 /* Is *W* a quoting (ASCII only) character? */
 179 #define ISQUOTE(W)      \
 180    ((W) == L'>' || (W) == L'|' || (W) == L'}' || (W) == L':')
 181
 182 /* Maximum number of quote characters (not bytes!) that'll be used on
 183  * follow lines when compressing leading quote characters */
 184 #define QUOTE_MAX       42
 185
 186 /* How much spaces should a <tab> count when *quote-fold*ing? (power-of-two!) */
 187 #define QUOTE_TAB_SPACES 8
 188
 189 /* Maximum size of a message that is passed through to the spam system */
 190 #define SPAM_MAXSIZE    420000
 191
 192 /* String dope: dynamic buffer size, and size of the single builtin one that's
 193  * used first */
 194 #define SBUFFER_SIZE    0x18000u
 195 #define SBUFFER_BUILTIN 0x2000u
 196
 197 /* These come from the configuration (named Xxy to not clash with sh(1)..) */
 198 #ifndef XSHELL
 199 # define XSHELL         "/bin/sh"
 200 #endif
 201 #ifndef XLISTER
 202 # define XLISTER        "ls"
 203 #endif
 204 #ifndef XPAGER
 205 # define XPAGER         "more"
 206 #endif
 207
 208 /*
 209  * CC support, generic macros etc.
 210  */
 211
 212 #undef __PREREQ
 213 #if defined __GNUC__ || defined __clang__
 214 # define __EXTEN  __extension__
 215 # ifdef __GNUC__
 216 #  define __PREREQ(X,Y) \
 217    (__GNUC__ > (X) || (__GNUC__ == (X) && __GNUC_MINOR__ >= (Y)))
 218 # else
 219 #  define __PREREQ(X,Y) 1
 220 # endif
 221 #else
 222 # define __EXTEN
 223 # define __PREREQ(X,Y)  0
 224 #endif
 225
 226 #define EMPTY_FILE(F)   typedef int CONCAT(avoid_empty_file__, F);
 227
 228 /* Pointer to size_t */
 229 #define PTR2SIZE(X)     ((size_t)(uintptr_t)(X))
 230
 231 /* Pointer comparison (types from below) */
 232 #define PTRCMP(A,C,B)   ((uintptr_t)(A) C (uintptr_t)(B))
 233
 234 /* Ditto, compare (maybe mixed-signed) integers cases to T bits, unsigned;
 235  * Note: doesn't sign-extend correctly, that's still up to the caller */
 236 #define UICMP(T,A,C,B)  ((ui ## T ## _t)(A) C (ui ## T ## _t)(B))
 237
 238 /* Members in constant array */
 239 #ifndef NELEM
 240 # define NELEM(A)       (sizeof(A) / sizeof(A[0]))
 241 #endif
 242
 243 /* sizeof() for member fields */
 244 #define SIZEOF_FIELD(T,F) sizeof(((T *)NULL)->F)
 245
 246 /* Casts-away (*NOT* cast-away) */
 247 #define UNUSED(X)       ((void)(X))
 248 #define UNCONST(P)      ((void*)(uintptr_t)(void const*)(P))
 249 #define UNVOLATILE(P)   ((void*)(uintptr_t)(void volatile*)(P))
 250 #define UNXXX(T,C,P)    ((T)(uintptr_t)(C)(P))
 251
 252 /* __STDC_VERSION__ is ISO C99, so also use __STDC__, which should work */
 253 #if defined __STDC__ || defined __STDC_VERSION__ /*|| defined __cplusplus*/
 254 # define STRING(X)      #X
 255 # define XSTRING(X)     STRING(X)
 256 # define CONCAT(S1,S2)  _CONCAT(S1, S2)
 257 # define _CONCAT(S1,S2) S1 ## S2
 258 #else
 259 # define STRING(X)      "X"
 260 # define XSTRING        STRING
 261 # define CONCAT(S1,S2)  S1/**/S2
 262 #endif
 263
 264 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 265   /* Variable size arrays and structure fields */
 266 # define VFIELD_SIZE(X)
 267 # define VFIELD_SIZEOF(T,F) (0)
 268   /* Inline functions */
 269 # define HAVE_INLINE
 270 # define INLINE         inline
 271 # define SINLINE        static inline
 272 #else
 273 # define VFIELD_SIZE(X) (X)
 274 # define VFIELD_SIZEOF(T,F) SIZEOF_FIELD(T, F)
 275 # if __PREREQ(2, 9)
 276 #   define INLINE       static __inline
 277 #   define SINLINE      static __inline
 278 # else
 279 #   define INLINE
 280 #   define SINLINE      static
 281 # endif
 282 #endif
 283
 284 #if defined __predict_true && defined __predict_false
 285 # define LIKELY(X)      __predict_true(X)
 286 # define UNLIKELY(X)    __predict_false(X)
 287 #elif __PREREQ(2, 96)
 288 # define LIKELY(X)      __builtin_expect(X, 1)
 289 # define UNLIKELY(X)    __builtin_expect(X, 0)
 290 #else
 291 # define LIKELY(X)      (X)
 292 # define UNLIKELY(X)    (X)
 293 #endif
 294
 295 /* Compile-Time-Assert */
 296 #define CTA(TEST)       _CTA_1(TEST, __LINE__)
 297 #define _CTA_1(TEST,L)  _CTA_2(TEST, L)
 298 #define _CTA_2(TEST,L)  \
 299    typedef char COMPILE_TIME_ASSERT_failed_at_line_ ## L[(TEST) ? 1 : -1]
 300
 301 #undef ISPOW2
 302 #define ISPOW2(X)       ((((X) - 1) & (X)) == 0)
 303 #undef MIN
 304 #define MIN(A, B)       ((A) < (B) ? (A) : (B))
 305 #undef MAX
 306 #define MAX(A, B)       ((A) < (B) ? (B) : (A))
 307 #undef ABS
 308 #define ABS(A)          ((A) < 0 ? -(A) : (A))
 309
 310 #undef DBG
 311 #undef NDBG
 312 #ifndef HAVE_DEBUG
 313 # undef assert
 314 # define assert(X)      UNUSED(0)
 315 # define DBG(X)
 316 # define NDBG(X)        X
 317 #else
 318 # define DBG(X)         X
 319 # define NDBG(X)
 320 #endif
 321
 322 /* Translation (init in main.c) */
 323 #undef tr
 324 #ifdef HAVE_CATGETS
 325 # define CATSET         1
 326 # define tr(c,d)        catgets(catd, CATSET, c, d)
 327 #else
 328 # define tr(c,d)        (d)
 329 #endif
 330
 331 /*
 332  * Types
 333  */
 334
 335 /* TODO convert all integer types to the new [su]i(8|16|32|64)_t */
 336 typedef unsigned long   ul_it;
 337 typedef unsigned int    ui_it;
 338 typedef unsigned short  us_it;
 339 typedef unsigned char   uc_it;
 340
 341 typedef signed long     sl_it;
 342 typedef signed int      si_it;
 343 typedef signed short    ss_it;
 344 typedef signed char     sc_it;
 345
 346 #ifdef UINT8_MAX
 347 # define UI8_MAX        UINT8_MAX
 348 # define SI8_MIN        INT8_MIN
 349 # define SI8_MAX        INT8_MAX
 350 typedef uint8_t         ui8_t;
 351 typedef int8_t          si8_t;
 352 #elif UCHAR_MAX != 255
 353 # error UCHAR_MAX must be 255
 354 #else
 355 # define UI8_MAX        UCHAR_MAX
 356 # define SI8_MIN        CHAR_MIN
 357 # define SI8_MAX        CHAR_MAX
 358 typedef unsigned char   ui8_t;
 359 typedef signed char     si8_t;
 360 #endif
 361
 362 #ifdef UINT16_MAX
 363 # define UI16_MAX       UINT16_MAX
 364 # define SI16_MIN       INT16_MIN
 365 # define SI16_MAX       INT16_MAX
 366 typedef uint16_t        ui16_t;
 367 typedef int16_t         si16_t;
 368 #elif USHRT_MAX != 0xFFFFu
 369 # error USHRT_MAX must be 0xFFFF
 370 #else
 371 # define UI16_MAX       USHRT_MAX
 372 # define SI16_MIN       SHRT_MIN
 373 # define SI16_MAX       SHRT_MAX
 374 typedef unsigned short  ui16_t;
 375 typedef signed short    si16_t;
 376 #endif
 377
 378 #ifdef UINT32_MAX
 379 # define UI32_MAX       UINT32_MAX
 380 # define SI32_MIN       INT32_MIN
 381 # define SI32_MAX       INT32_MAX
 382 typedef uint32_t        ui32_t;
 383 typedef int32_t         si32_t;
 384 #elif ULONG_MAX == 0xFFFFFFFFu
 385 # define UI32_MAX       ULONG_MAX
 386 # define SI32_MIN       LONG_MIN
 387 # define SI32_MAX       LONG_MAX
 388 typedef unsigned long int  ui32_t;
 389 typedef signed long int    si32_t;
 390 #elif UINT_MAX != 0xFFFFFFFFu
 391 # error UINT_MAX must be 0xFFFFFFFF
 392 #else
 393 # define UI32_MAX       UINT_MAX
 394 # define SI32_MIN       INT_MIN
 395 # define SI32_MAX       INT_MAX
 396 typedef unsigned int    ui32_t;
 397 typedef signed int      si32_t;
 398 #endif
 399
 400 #ifdef UINT64_MAX
 401 # define UI64_MAX       UINT64_MAX
 402 # define SI64_MIN       INT64_MIN
 403 # define SI64_MAX       INT64_MAX
 404 typedef uint64_t        ui64_t;
 405 #elif ULONG_MAX <= 0xFFFFFFFFu
 406 # if !defined ULLONG_MAX || ULLONG_MAX != 0xFFFFFFFFFFFFFFFFu
 407 #  error We need a 64 bit integer
 408 # else
 409 #  define UI64_MAX      ULLONG_MAX
 410 #  define SI64_MIN      LLONG_MIN
 411 #  define SI64_MAX      LLONG_MAX
 412 __EXTEN typedef unsigned long long  ui64_t;
 413 __EXTEN typedef signed long long    si64_t;
 414 # endif
 415 #else
 416 # define UI64_MAX       ULONG_MAX
 417 # define SI64_MIN       LONG_MIN
 418 # define SI64_MAX       LONG_MAX
 419 typedef unsigned long   ui64_t;
 420 typedef signed long     si64_t;
 421 #endif
 422
 423 /* (So that we can use UICMP() for size_t comparison, too) */
 424 typedef size_t          uiz_t;
 425 /*typedef ssize_t         siz_t;*/
 426
 427 #ifndef UINTPTR_MAX
 428 # ifdef SIZE_MAX
 429 #  define uintptr_t     size_t
 430 #  define UINTPTR_MAX   SIZE_MAX
 431 # else
 432 #  define uintptr_t     unsigned long
 433 #  define UINTPTR_MAX   ULONG_MAX
 434 # endif
 435 #endif
 436
 437 /* XXX Note we don't really deal with that the right way in that we pass size_t
 438  * XXX arguments without casting; should do, because above we assert UINT_MAX
 439  * XXX is indeed ui32_t */
 440 #if defined __STDC_VERSION__ && __STDC_VERSION__ + 0 >= 199901L
 441 # define ZFMT           "zu"
 442 #elif defined SIZE_MAX && SIZE_MAX == 0xFFFFFFFFu && ULONG_MAX != UINT_MAX
 443 # define ZFMT           "u"
 444 #endif
 445 #ifndef ZFMT
 446 # define ZFMT           "lu"
 447 #endif
 448
 449 typedef enum {FAL0, TRU1}  bool_t;
 450
 451 typedef void (             *sighandler_type)(int);
 452
 453 enum user_options {
 454    OPT_NONE,
 455    OPT_DEBUG      = 1u<< 0,   /* -d / *debug* */
 456    OPT_VERBOSE    = 1u<< 1,   /* -v / *verbose* */
 457    OPT_EXISTONLY  = 1u<< 2,   /* -e */
 458    OPT_HEADERSONLY = 1u<< 3,  /* -H */
 459    OPT_NOSRC      = 1u<< 4,   /* -n */
 460    OPT_E_FLAG     = 1u<< 5,   /* -E / *skipemptybody* */
 461    OPT_F_FLAG     = 1u<< 6,   /* -F */
 462    OPT_N_FLAG     = 1u<< 7,   /* -N / *header* */
 463    OPT_R_FLAG     = 1u<< 8,   /* -R */
 464    OPT_r_FLAG     = 1u<< 9,   /* -r (plus option_r_arg) */
 465    OPT_t_FLAG     = 1u<<10,   /* -t */
 466    OPT_u_FLAG     = 1u<<11,   /* -u given, or USER != getpwnam(3) */
 467    OPT_TILDE_FLAG = 1u<<12,   /* -~ */
 468    OPT_BATCH_FLAG = 1u<<13,   /* -# */
 469
 470    OPT_SENDMODE   = 1u<<14,   /* Usage case forces send mode */
 471    OPT_INTERACTIVE = 1u<<15,  /* isatty(0) */
 472    OPT_TTYIN      = OPT_INTERACTIVE,
 473    OPT_TTYOUT     = 1u<<16
 474 };
 475 #define IS_TTY_SESSION() \
 476    ((options & (OPT_TTYIN | OPT_TTYOUT)) == (OPT_TTYIN | OPT_TTYOUT))
 477
 478 enum exit_status {
 479    EXIT_OK        = EXIT_SUCCESS,
 480    EXIT_ERR       = EXIT_FAILURE,
 481    EXIT_COLL_ABORT = 1<<1,    /* Message collection was aborted */
 482    EXIT_SEND_ERROR = 1<<2     /* Unspecified send error occurred */
 483 };
 484
 485 enum fexp_mode {
 486    FEXP_FULL,                 /* Full expansion */
 487    FEXP_LOCAL     = 1<<0,     /* Result must be local file/maildir */
 488    FEXP_SHELL     = 1<<1,     /* No folder %,#,&,+ stuff, yet sh(1) */
 489    FEXP_NSHORTCUT = 1<<2,     /* Don't expand shortcuts */
 490    FEXP_SILENT    = 1<<3,     /* Don't print but only return errors */
 491    FEXP_MULTIOK   = 1<<4      /* Expansion to many entries is ok */
 492 };
 493
 494 /* <0 means "stop" unless *prompt* extensions are enabled. */
 495 enum prompt_exp {
 496    PROMPT_STOP    = -1,       /* \c */
 497    /* *prompt* extensions: \$, \@ etc. */
 498    PROMPT_DOLLAR  = -2,
 499    PROMPT_AT      = -3
 500 };
 501
 502 enum colourspec {
 503    COLOURSPEC_MSGINFO,
 504    COLOURSPEC_PARTINFO,
 505    COLOURSPEC_FROM_,
 506    COLOURSPEC_HEADER,
 507    COLOURSPEC_UHEADER,
 508    COLOURSPEC_RESET
 509 };
 510
 511 enum okay {
 512    STOP = 0,
 513    OKAY = 1
 514 };
 515
 516 enum mimeenc {
 517    MIME_NONE,        /* message is not in MIME format */
 518    MIME_BIN,         /* message is in binary encoding */
 519    MIME_8B,          /* message is in 8bit encoding */
 520    MIME_7B,          /* message is in 7bit encoding */
 521    MIME_QP,          /* message is quoted-printable */
 522    MIME_B64          /* message is in base64 encoding */
 523 };
 524
 525 enum conversion {
 526    CONV_NONE,        /* no conversion */
 527    CONV_7BIT,        /* no conversion, is 7bit */
 528    CONV_FROMQP,      /* convert from quoted-printable */
 529    CONV_TOQP,        /* convert to quoted-printable */
 530    CONV_8BIT,        /* convert to 8bit (iconv) */
 531    CONV_FROMB64,     /* convert from base64 */
 532    CONV_FROMB64_T,   /* convert from base64/text */
 533    CONV_TOB64,       /* convert to base64 */
 534    CONV_FROMHDR,     /* convert from RFC1522 format */
 535    CONV_TOHDR,       /* convert to RFC1522 format */
 536    CONV_TOHDR_A      /* convert addresses for header */
 537 };
 538
 539 enum sendaction {
 540    SEND_MBOX,        /* no conversion to perform */
 541    SEND_RFC822,      /* no conversion, no From_ line */
 542    SEND_TODISP,      /* convert to displayable form */
 543    SEND_TODISP_ALL,  /* same, include all MIME parts */
 544    SEND_SHOW,        /* convert to 'show' command form */
 545    SEND_TOSRCH,      /* convert for IMAP SEARCH */
 546    SEND_TOFLTR,      /* convert for spam mail filtering */
 547    SEND_TOFILE,      /* convert for saving body to a file */
 548    SEND_TOPIPE,      /* convert for pipe-content/subc. */
 549    SEND_QUOTE,       /* convert for quoting */
 550    SEND_QUOTE_ALL,   /* same, include all MIME parts */
 551    SEND_DECRYPT      /* decrypt */
 552 };
 553
 554 enum mimecontent {
 555    MIME_UNKNOWN,     /* unknown content */
 556    MIME_SUBHDR,      /* inside a multipart subheader */
 557    MIME_822,         /* message/rfc822 content */
 558    MIME_MESSAGE,     /* other message/ content */
 559    MIME_TEXT_PLAIN,  /* text/plain content */
 560    MIME_TEXT_HTML,   /* text/html content */
 561    MIME_TEXT,        /* other text/ content */
 562    MIME_ALTERNATIVE, /* multipart/alternative content */
 563    MIME_DIGEST,      /* multipart/digest content */
 564    MIME_MULTI,       /* other multipart/ content */
 565    MIME_PKCS7,       /* PKCS7 content */
 566    MIME_DISCARD      /* content is discarded */
 567 };
 568
 569 enum tdflags {
 570    TD_NONE,                   /* no display conversion */
 571    TD_ISPR        = 1<<0,     /* use isprint() checks */
 572    TD_ICONV       = 1<<1,     /* use iconv() */
 573    TD_DELCTRL     = 1<<2,     /* delete control characters */
 574
 575    /*
 576     * NOTE: _TD_EOF and _TD_BUFCOPY may be ORd with enum conversion and
 577     * enum sendaction, and may thus NOT clash with their bit range!
 578     */
 579    _TD_EOF        = 1<<14,    /* EOF seen, last round! */
 580    _TD_BUFCOPY    = 1<<15     /* Buffer may be constant, copy it */
 581 };
 582
 583 enum protocol {
 584    PROTO_FILE,       /* refers to a local file */
 585    PROTO_POP3,       /* is a pop3 server string */
 586    PROTO_IMAP,       /* is an imap server string */
 587    PROTO_MAILDIR,    /* refers to a maildir folder */
 588    PROTO_UNKNOWN     /* unknown protocol */
 589 };
 590
 591 #ifdef HAVE_SSL
 592 enum ssl_vrfy_level {
 593    VRFY_IGNORE,
 594    VRFY_WARN,
 595    VRFY_ASK,
 596    VRFY_STRICT
 597 };
 598 #endif
 599
 600 /* A large enum with all the binary and value options a.k.a their keys.
 601  * Only the constant keys are in here, to be looked up via ok_[bv]look(),
 602  * ok_[bv]set() and ok_[bv]clear().
 603  * Note: see the comments in acmava.c before changing *anything* in here! */
 604 enum okeys {
 605    /* Option keys for binary options */
 606    ok_b_add_file_recipients,
 607    ok_b_allnet,
 608    ok_b_append,
 609    ok_b_ask,
 610    ok_b_askatend,
 611    ok_b_askattach,
 612    ok_b_askbcc,
 613    ok_b_askcc,
 614    ok_b_asksign,
 615    ok_b_asksub,
 616    ok_b_attachment_ask_content_description,
 617    ok_b_attachment_ask_content_disposition,
 618    ok_b_attachment_ask_content_id,
 619    ok_b_attachment_ask_content_type,
 620    ok_b_autocollapse,
 621    ok_b_autoprint,
 622    ok_b_autothread,
 623    ok_b_bang,
 624    ok_b_batch_exit_on_error,
 625    ok_b_bsdannounce,
 626    ok_b_bsdcompat,
 627    ok_b_bsdflags,
 628    ok_b_bsdheadline,
 629    ok_b_bsdmsgs,
 630    ok_b_bsdorder,
 631    ok_b_bsdset,
 632    ok_b_colour_disable,
 633    ok_b_debug,                         /* {special=1} */
 634    ok_b_disconnected,
 635    ok_b_dot,
 636    ok_b_editalong,
 637    ok_b_editheaders,
 638    ok_b_emptybox,
 639    ok_b_emptystart,
 640    ok_b_flipr,
 641    ok_b_forward_as_attachment,
 642    ok_b_fullnames,
 643    ok_b_header,                        /* {special=1} */
 644    ok_b_hold,
 645    ok_b_idna_disable,
 646    ok_b_ignore,
 647    ok_b_ignoreeof,
 648    ok_b_imap_use_starttls,
 649    ok_b_keep,
 650    ok_b_keep_content_length,
 651    ok_b_keepsave,
 652    ok_b_line_editor_disable,
 653    ok_b_markanswered,
 654    ok_b_message_id_disable,
 655    ok_b_metoo,
 656    ok_b_mime_allow_text_controls,
 657    ok_b_mime_counter_evidence,
 658    ok_b_outfolder,
 659    ok_b_page,
 660    ok_b_piperaw,
 661    ok_b_pop3_bulk_load,
 662    ok_b_pop3_no_apop,
 663    ok_b_pop3_use_starttls,
 664    ok_b_print_all_chars,
 665    ok_b_print_alternatives,
 666    ok_b_quiet,
 667    ok_b_quote_as_attachment,
 668    ok_b_recipients_in_cc,
 669    ok_b_record_resent,
 670    ok_b_reply_in_same_charset,
 671    ok_b_Replyall,
 672    ok_b_rfc822_body_from_,             /* {name=rfc822-body-from_} */
 673    ok_b_save,
 674    ok_b_searchheaders,
 675    ok_b_sendcharsets_else_ttycharset,
 676    ok_b_sendwait,
 677    ok_b_showlast,
 678    ok_b_showname,
 679    ok_b_showto,
 680    ok_b_skipemptybody,                 /* {special=1} */
 681    ok_b_smime_force_encryption,
 682    ok_b_smime_no_default_ca,
 683    ok_b_smime_sign,
 684    ok_b_smtp_use_starttls,
 685    ok_b_ssl_no_default_ca,
 686    ok_b_ssl_v2_allow,
 687    ok_b_writebackedited,
 688    ok_b_verbose,                       /* {special=1} */
 689
 690    /* Option keys for values options */
 691    ok_v_attrlist,
 692    ok_v_autobcc,
 693    ok_v_autocc,
 694    /* XXX autoinc is the same as *newmail*, unite!! */
 695    ok_v_autoinc,
 696    ok_v_autosort,
 697    ok_v_charset_7bit,
 698    ok_v_charset_8bit,
 699    ok_v_cmd,
 700    ok_v_colour_pagers,
 701    ok_v_colour_from_,                  /* {name=colour-from_} */
 702    ok_v_colour_header,
 703    ok_v_colour_msginfo,
 704    ok_v_colour_partinfo,
 705    ok_v_colour_terms,
 706    ok_v_colour_uheader,
 707    ok_v_colour_user_headers,
 708    ok_v_crt,
 709    ok_v_datefield,
 710    ok_v_datefield_markout_older,
 711    ok_v_DEAD,
 712    ok_v_EDITOR,
 713    ok_v_encoding,
 714    ok_v_escape,
 715    ok_v_folder,                        /* {special=1} */
 716    ok_v_folder_hook,
 717    ok_v_from,
 718    ok_v_fwdheading,
 719    ok_v_headline,
 720    ok_v_hostname,
 721    ok_v_imap_auth,
 722    ok_v_imap_cache,
 723    ok_v_imap_keepalive,
 724    ok_v_imap_list_depth,
 725    ok_v_indentprefix,
 726    ok_v_line_editor_cursor_right,      /* {special=1} */
 727    ok_v_LISTER,
 728    ok_v_MAIL,
 729    ok_v_MBOX,
 730    ok_v_mimetypes_load_control,
 731    ok_v_NAIL_EXTRA_RC,                 /* {name=NAIL_EXTRA_RC} */
 732    ok_v_NAIL_HEAD,                     /* {name=NAIL_HEAD} */
 733    ok_v_NAIL_HISTFILE,                 /* {name=NAIL_HISTFILE} */
 734    ok_v_NAIL_HISTSIZE,                 /* {name=NAIL_HISTSIZE} */
 735    ok_v_NAIL_TAIL,                     /* {name=NAIL_TAIL} */
 736    ok_v_newfolders,
 737    ok_v_newmail,
 738    ok_v_ORGANIZATION,
 739    ok_v_PAGER,
 740    ok_v_pop3_keepalive,
 741    ok_v_prompt,
 742    ok_v_quote,
 743    ok_v_quote_fold,
 744    ok_v_record,
 745    ok_v_replyto,
 746    ok_v_screen,
 747    ok_v_sendcharsets,
 748    ok_v_sender,
 749    ok_v_sendmail,
 750    ok_v_sendmail_progname,
 751    ok_v_SHELL,
 752    ok_v_Sign,
 753    ok_v_sign,
 754    ok_v_signature,
 755    ok_v_smime_ca_dir,
 756    ok_v_smime_ca_file,
 757    ok_v_smime_crl_dir,
 758    ok_v_smime_crl_file,
 759    ok_v_smime_sign_cert,
 760    ok_v_smime_sign_include_certs,
 761    ok_v_smtp,
 762    ok_v_smtp_auth,
 763    ok_v_smtp_auth_password,
 764    ok_v_smtp_auth_user,
 765    ok_v_spam_command,
 766    ok_v_spam_host,
 767    ok_v_spam_maxsize,
 768    ok_v_spam_port,
 769    ok_v_spam_socket,
 770    ok_v_spam_user,
 771    ok_v_ssl_ca_dir,
 772    ok_v_ssl_ca_file,
 773    ok_v_ssl_cert,
 774    ok_v_ssl_cipher_list,
 775    ok_v_ssl_crl_dir,
 776    ok_v_ssl_crl_file,
 777    ok_v_ssl_key,
 778    ok_v_ssl_method,
 779    ok_v_ssl_rand_egd,
 780    ok_v_ssl_rand_file,
 781    ok_v_ssl_verify,
 782    ok_v_stealthmua,
 783    ok_v_toplines,
 784    ok_v_ttycharset,
 785    ok_v_VISUAL
 786 };
 787
 788 struct str {
 789    char     *s;      /* the string's content */
 790    size_t   l;       /* the stings's length */
 791 };
 792
 793 struct colour_table {
 794    /* Plus a copy of *colour-user-headers* */
 795    struct str  ct_csinfo[COLOURSPEC_RESET+1 + 1];
 796 };
 797
 798 struct time_current {
 799    time_t      tc_time;
 800    struct tm   tc_gm;
 801    struct tm   tc_local;
 802    char        tc_ctime[32];
 803 };
 804
 805 struct quoteflt {
 806    FILE        *qf_os;        /* Output stream */
 807    char const  *qf_pfix;
 808    ui_it       qf_pfix_len;   /* Length of prefix: 0: bypass */
 809    ui_it       qf_qfold_min;  /* Simple way: wrote prefix? */
 810 #ifdef HAVE_QUOTE_FOLD
 811    ui_it       qf_qfold_max;  /* Otherwise: line lengths */
 812    uc_it       qf_state;      /* *quote-fold* state machine */
 813    bool_t      qf_brk_isws;   /* Breakpoint is at WS */
 814    uc_it       __dummy[2];
 815    ui_it       qf_wscnt;      /* Whitespace count */
 816    ui_it       qf_brkl;       /* Breakpoint */
 817    ui_it       qf_brkw;       /* Visual width, breakpoint */
 818    ui_it       qf_datw;       /* Current visual output line width */
 819    struct str  qf_dat;        /* Current visual output line */
 820    struct str  qf_currq;      /* Current quote, compressed */
 821    mbstate_t   qf_mbps[2];
 822 #endif
 823 };
 824
 825 struct eval_ctx {
 826    struct str  ev_line;
 827    bool_t      ev_is_recursive;  /* Evaluation in evaluation? (collect ~:) */
 828    ui8_t       __dummy[6];
 829    bool_t      ev_add_history;   /* Enter (final) command in history? */
 830    char const  *ev_new_content;  /* History: reenter line, start with this */
 831 };
 832
 833 struct termios_state {
 834    struct termios ts_tios;
 835    char        *ts_linebuf;
 836    size_t      ts_linesize;
 837    bool_t      ts_needs_reset;
 838 };
 839
 840 #define termios_state_reset() \
 841 do {\
 842    if (termios_state.ts_needs_reset) {\
 843       tcsetattr(0, TCSADRAIN, &termios_state.ts_tios);\
 844       termios_state.ts_needs_reset = FAL0;\
 845    }\
 846 } while (0)
 847
 848 struct sock {                 /* data associated with a socket */
 849    int         s_fd;          /* file descriptor */
 850 #ifdef HAVE_SSL
 851    int         s_use_ssl;     /* SSL is used */
 852 # ifdef HAVE_OPENSSL
 853    void        *s_ssl;        /* SSL object */
 854    void        *s_ctx;        /* SSL context object */
 855 # endif
 856 #endif
 857    char        *s_wbuf;       /* for buffered writes */
 858    int         s_wbufsize;    /* allocated size of s_buf */
 859    int         s_wbufpos;     /* position of first empty data byte */
 860    char        *s_rbufptr;    /* read pointer to s_rbuf */
 861    int         s_rsz;         /* size of last read in s_rbuf */
 862    char const  *s_desc;       /* description of error messages */
 863    void        (*s_onclose)(void); /* execute on close */
 864    char        s_rbuf[LINESIZE + 1]; /* for buffered reads */
 865 };
 866
 867 struct mailbox {
 868    enum {
 869       MB_NONE     = 000,      /* no reply expected */
 870       MB_COMD     = 001,      /* command reply expected */
 871       MB_MULT     = 002,      /* multiline reply expected */
 872       MB_PREAUTH  = 004,      /* not in authenticated state */
 873       MB_BYE      = 010       /* may accept a BYE state */
 874    }           mb_active;
 875    FILE        *mb_itf;       /* temp file with messages, read open */
 876    FILE        *mb_otf;       /* same, write open */
 877    char        *mb_sorted;    /* sort method */
 878    enum {
 879       MB_VOID,       /* no type (e. g. connection failed) */
 880       MB_FILE,       /* local file */
 881       MB_POP3,       /* POP3 mailbox */
 882       MB_IMAP,       /* IMAP mailbox */
 883       MB_MAILDIR,    /* maildir folder */
 884       MB_CACHE       /* cached mailbox */
 885    }           mb_type;       /* type of mailbox */
 886    enum {
 887       MB_DELE = 01,  /* may delete messages in mailbox */
 888       MB_EDIT = 02   /* may edit messages in mailbox */
 889    }           mb_perm;
 890    int mb_compressed;         /* is a compressed mbox file */
 891    int mb_threaded;           /* mailbox has been threaded */
 892 #ifdef HAVE_IMAP
 893    enum mbflags {
 894       MB_NOFLAGS  = 000,
 895       MB_UIDPLUS  = 001 /* supports IMAP UIDPLUS */
 896    }           mb_flags;
 897    unsigned long  mb_uidvalidity;   /* IMAP unique identifier validity */
 898    char        *mb_imap_account;    /* name of current IMAP account */
 899    char        *mb_imap_mailbox;    /* name of current IMAP mailbox */
 900    char        *mb_cache_directory; /* name of cache directory */
 901 #endif
 902    struct sock mb_sock;       /* socket structure */
 903 };
 904
 905 enum needspec {
 906    NEED_UNSPEC,      /* unspecified need, don't fetch */
 907    NEED_HEADER,      /* need the header of a message */
 908    NEED_BODY         /* need header and body of a message */
 909 };
 910
 911 enum havespec {
 912    HAVE_NOTHING,              /* nothing downloaded yet */
 913    HAVE_HEADER    = 01,       /* header is downloaded */
 914    HAVE_BODY      = 02        /* entire message is downloaded */
 915 };
 916
 917 /* flag bits. Attention: Flags that are used in cache.c may not change */
 918 enum mflag {
 919    MUSED          = (1<< 0),  /* entry is used, but this bit isn't */
 920    MDELETED       = (1<< 1),  /* entry has been deleted */
 921    MSAVED         = (1<< 2),  /* entry has been saved */
 922    MTOUCH         = (1<< 3),  /* entry has been noticed */
 923    MPRESERVE      = (1<< 4),  /* keep entry in sys mailbox */
 924    MMARK          = (1<< 5),  /* message is marked! */
 925    MODIFY         = (1<< 6),  /* message has been modified */
 926    MNEW           = (1<< 7),  /* message has never been seen */
 927    MREAD          = (1<< 8),  /* message has been read sometime. */
 928    MSTATUS        = (1<< 9),  /* message status has changed */
 929    MBOX           = (1<<10),  /* Send this to mbox, regardless */
 930    MNOFROM        = (1<<11),  /* no From line */
 931    MHIDDEN        = (1<<12),  /* message is hidden to user */
 932    MFULLYCACHED   = (1<<13),  /* message is completely cached */
 933    MBOXED         = (1<<14),  /* message has been sent to mbox */
 934    MUNLINKED      = (1<<15),  /* message was unlinked from cache */
 935    MNEWEST        = (1<<16),  /* message is very new (newmail) */
 936    MFLAG          = (1<<17),  /* message has been flagged recently */
 937    MUNFLAG        = (1<<18),  /* message has been unflagged */
 938    MFLAGGED       = (1<<19),  /* message is `flagged' */
 939    MANSWER        = (1<<20),  /* message has been answered recently */
 940    MUNANSWER      = (1<<21),  /* message has been unanswered */
 941    MANSWERED      = (1<<22),  /* message is `answered' */
 942    MDRAFT         = (1<<23),  /* message has been drafted recently */
 943    MUNDRAFT       = (1<<24),  /* message has been undrafted */
 944    MDRAFTED       = (1<<25),  /* message is marked as `draft' */
 945    MOLDMARK       = (1<<26),  /* messages was marked previously */
 946    MSPAM          = (1<<27)   /* message is classified as spam */
 947 };
 948 #define MMNORM          (MDELETED | MSAVED | MHIDDEN)
 949 #define MMNDEL          (MDELETED | MHIDDEN)
 950
 951 #define visible(mp)     (((mp)->m_flag & MMNDEL) == 0)
 952
 953 struct mimepart {
 954    enum mflag  m_flag;        /* flags */
 955    enum havespec m_have;      /* downloaded parts of the part */
 956 #ifdef HAVE_SPAM
 957    ui_it       m_spamscore;   /* Spam score as int, 24:8 bits */
 958 #endif
 959    int         m_block;       /* block number of this part */
 960    size_t      m_offset;      /* offset in block of part */
 961    size_t      m_size;        /* Bytes in the part */
 962    size_t      m_xsize;       /* Bytes in the full part */
 963    long        m_lines;       /* Lines in the message */
 964    long        m_xlines;      /* Lines in the full message */
 965    time_t      m_time;        /* time the message was sent */
 966    char const  *m_from;       /* message sender */
 967    struct mimepart *m_nextpart;     /* next part at same level */
 968    struct mimepart *m_multipart;    /* parts of multipart */
 969    struct mimepart *m_parent;       /* enclosing multipart part */
 970    char        *m_ct_type;          /* content-type */
 971    char        *m_ct_type_plain;    /* content-type without specs */
 972    enum mimecontent m_mimecontent;  /* same in enum */
 973    char const  *m_charset;    /* charset */
 974    char        *m_ct_transfer_enc;  /* content-transfer-encoding */
 975    enum mimeenc m_mimeenc;     /* same in enum */
 976    char        *m_partstring; /* part level string */
 977    char        *m_filename;   /* attachment filename */
 978 };
 979
 980 struct message {
 981    enum mflag  m_flag;        /* flags */
 982    enum havespec m_have;      /* downloaded parts of the message */
 983 #ifdef HAVE_SPAM
 984    ui_it       m_spamscore;   /* Spam score as int, 24:8 bits */
 985 #endif
 986    int         m_block;       /* block number of this message */
 987    size_t      m_offset;      /* offset in block of message */
 988    size_t      m_size;        /* Bytes in the message */
 989    size_t      m_xsize;       /* Bytes in the full message */
 990    long        m_lines;       /* Lines in the message */
 991    long        m_xlines;      /* Lines in the full message */
 992    time_t      m_time;        /* time the message was sent */
 993    time_t      m_date;        /* time in the 'Date' field */
 994    unsigned    m_idhash;      /* hash on Message-ID for threads */
 995    struct message *m_child;   /* first child of this message */
 996    struct message *m_younger; /* younger brother of this message */
 997    struct message *m_elder;   /* elder brother of this message */
 998    struct message *m_parent;  /* parent of this message */
 999    unsigned    m_level;       /* thread level of message */
1000    long        m_threadpos;   /* position in threaded display */
1001 #ifdef HAVE_IMAP
1002    unsigned long m_uid;       /* IMAP unique identifier */
1003 #endif
1004    char        *m_maildir_file;  /* original maildir file of msg */
1005    unsigned    m_maildir_hash;   /* hash of file name in maildir sub */
1006    int         m_collapsed;      /* collapsed thread information */
1007 };
1008
1009 /* Given a file address, determine the block number it represents */
1010 #define mailx_blockof(off)                ((int) ((off) / 4096))
1011 #define mailx_offsetof(off)               ((int) ((off) % 4096))
1012 #define mailx_positionof(block, offset)   ((off_t)(block) * 4096 + (offset))
1013
1014 /* Argument types */
1015 enum argtype {
1016    ARG_MSGLIST    = 0,        /* Message list type */
1017    ARG_STRLIST    = 1,        /* A pure string */
1018    ARG_RAWLIST    = 2,        /* Shell string list */
1019    ARG_NOLIST     = 3,        /* Just plain 0 */
1020    ARG_NDMLIST    = 4,        /* Message list, no defaults */
1021    ARG_ECHOLIST   = 5,        /* Like raw list, but keep quote chars */
1022    ARG_ARGMASK    = 7,        /* Mask of the above */
1023
1024    ARG_A          = 1u<< 4,   /* Needs an active mailbox */
1025    ARG_F          = 1u<< 5,   /* Is a conditional command */
1026    ARG_H          = 1u<< 6,   /* Never place in history */
1027    ARG_I          = 1u<< 7,   /* Interactive command bit */
1028    ARG_M          = 1u<< 8,   /* Legal from send mode bit */
1029    ARG_P          = 1u<< 9,   /* Autoprint dot after command */
1030    ARG_R          = 1u<<10,   /* Cannot be called from collect / recursion */
1031    ARG_T          = 1u<<11,   /* Is a transparent command */
1032    ARG_V          = 1u<<12,   /* Places data in temporary_arg_v_store */
1033    ARG_W          = 1u<<13    /* Illegal when read only bit */
1034 };
1035
1036 enum gfield {
1037    GTO            = 1,        /* Grab To: line */
1038    GSUBJECT       = 2,        /* Likewise, Subject: line */
1039    GCC            = 4,        /* And the Cc: line */
1040    GBCC           = 8,        /* And also the Bcc: line */
1041
1042    GNL            = 16,       /* Print blank line after */
1043    GDEL           = 32,       /* Entity removed from list */
1044    GCOMMA         = 64,       /* detract puts in commas */
1045    GUA            = 128,      /* User-Agent field */
1046    GMIME          = 256,      /* MIME 1.0 fields */
1047    GMSGID         = 512,      /* a Message-ID */
1048    /* 1024 */
1049    GIDENT         = 2048,     /* From:, Reply-To: and Organization: field */
1050    GREF           = 4096,     /* References: field */
1051    GDATE          = 8192,     /* Date: field */
1052    GFULL          = 16384,    /* include full names */
1053    GSKIN          = 32768,    /* skin names */
1054    GEXTRA         = 65536,    /* extra fields */
1055    GFILES         = 131072    /* include filename addresses */
1056 };
1057 #define GMASK           (GTO | GSUBJECT | GCC | GBCC)
1058
1059 /* Structure used to pass about the current state of a message (header) */
1060 struct header {
1061    struct name *h_to;         /* Dynamic "To:" string */
1062    char        *h_subject;    /* Subject string */
1063    struct name *h_cc;         /* Carbon copies string */
1064    struct name *h_bcc;        /* Blind carbon copies */
1065    struct name *h_ref;        /* References */
1066    struct attachment *h_attach; /* MIME attachments */
1067    char        *h_charset;    /* preferred charset */
1068    struct name *h_from;       /* overridden "From:" field */
1069    struct name *h_replyto;    /* overridden "Reply-To:" field */
1070    struct name *h_sender;     /* overridden "Sender:" field */
1071    char        *h_organization; /* overridden "Organization:" field */
1072 };
1073
1074 /* Handling of namelist nodes used in processing the recipients of mail and
1075  * aliases, inspection of mail-addresses and all that kind of stuff */
1076 enum nameflags {
1077    NAME_NAME_SALLOC        = 1<< 0, /* .n_name is doped */
1078    NAME_FULLNAME_SALLOC    = 1<< 1, /* .n_fullname is doped */
1079    NAME_SKINNED            = 1<< 2, /* Is actually skin()ned */
1080    NAME_IDNA               = 1<< 3, /* IDNA was applied */
1081    NAME_ADDRSPEC_CHECKED   = 1<< 4, /* Address has been .. and */
1082    NAME_ADDRSPEC_ISFILE    = 1<< 5, /* ..is a file path */
1083    NAME_ADDRSPEC_ISPIPE    = 1<< 6, /* ..is a command for piping */
1084    NAME_ADDRSPEC_ISFILEORPIPE = NAME_ADDRSPEC_ISFILE | NAME_ADDRSPEC_ISPIPE,
1085    NAME_ADDRSPEC_ERR_EMPTY = 1<< 7, /* An empty string (or NULL) */
1086    NAME_ADDRSPEC_ERR_ATSEQ = 1<< 8, /* Weird @ sequence */
1087    NAME_ADDRSPEC_ERR_CHAR  = 1<< 9, /* Invalid character */
1088    NAME_ADDRSPEC_ERR_IDNA  = 1<<10, /* IDNA convertion failed */
1089    NAME_ADDRSPEC_INVALID   = NAME_ADDRSPEC_ERR_EMPTY |
1090          NAME_ADDRSPEC_ERR_ATSEQ | NAME_ADDRSPEC_ERR_CHAR |
1091          NAME_ADDRSPEC_ERR_IDNA,
1092
1093    _NAME_SHIFTWC  = 11,
1094    _NAME_MAXWC    = 0xFFFFF,
1095    _NAME_MASKWC   = _NAME_MAXWC << _NAME_SHIFTWC
1096 };
1097
1098 /* In the !_ERR_EMPTY case, the failing character can be queried */
1099 #define NAME_ADDRSPEC_ERR_GETWC(F)  \
1100    ((((unsigned int)(F) & _NAME_MASKWC) >> _NAME_SHIFTWC) & _NAME_MAXWC)
1101 #define NAME_ADDRSPEC_ERR_SET(F, E, WC) \
1102 do {\
1103    (F) = ((F) & ~(NAME_ADDRSPEC_INVALID | _NAME_MASKWC)) |\
1104          (E) | (((unsigned int)(WC) & _NAME_MAXWC) << _NAME_SHIFTWC);\
1105 } while (0)
1106
1107 struct name {
1108    struct name *n_flink;      /* Forward link in list. */
1109    struct name *n_blink;      /* Backward list link */
1110    enum gfield n_type;        /* From which list it came */
1111    enum nameflags n_flags;    /* enum nameflags */
1112    char        *n_name;       /* This fella's name */
1113    char        *n_fullname;   /* Sometimes, name including comment */
1114 };
1115
1116 struct addrguts {
1117    char const  *ag_input;     /* Input string as given */
1118    size_t      ag_ilen;       /* strlen() of input */
1119    size_t      ag_iaddr_start; /* Start of *addr-spec* in .ag_input */
1120    size_t      ag_iaddr_aend; /* ..and one past its end */
1121    char        *ag_skinned;   /* Output (alloced if !=.ag_input) */
1122    size_t      ag_slen;       /* strlen() of .ag_skinned */
1123    size_t      ag_sdom_start; /* Start of domain in .ag_skinned, */
1124    enum nameflags ag_n_flags; /* enum nameflags of .ag_skinned */
1125 };
1126
1127 /* MIME attachments */
1128 enum attach_conv {
1129    AC_DEFAULT,       /* _get_lc() -> _iter_*() */
1130    AC_FIX_OUTCS,     /* _get_lc() -> "charset=" .a_charset */
1131    AC_FIX_INCS,      /* "charset=".a_input_charset (nocnv) */
1132    AC_TMPFILE        /* attachment.a_tmpf is converted */
1133 };
1134
1135 struct attachment {
1136    struct attachment *a_flink;   /* Forward link in list. */
1137    struct attachment *a_blink;   /* Backward list link */
1138    char const  *a_name;       /* file name */
1139    char const  *a_content_type;  /* content type */
1140    char const  *a_content_disposition; /* content disposition */
1141    char const  *a_content_id; /* content id */
1142    char const  *a_content_description; /* content description */
1143    char const  *a_input_charset; /* Interpretation depends on .a_conv */
1144    char const  *a_charset;    /* ... */
1145    FILE        *a_tmpf;       /* If AC_TMPFILE */
1146    enum attach_conv a_conv;   /* User chosen conversion */
1147    int         a_msgno;       /* message number */
1148 };
1149
1150 struct group {
1151    struct group *ge_link;     /* Next person in this group */
1152    char        *ge_name;      /* This person's user name */
1153 };
1154
1155 struct grouphead {
1156    struct grouphead *g_link;  /* Next grouphead in list */
1157    char        *g_name;       /* Name of this group */
1158    struct group *g_list;      /* Users in group. */
1159 };
1160
1161 /* Structure of the hash table of ignored header fields */
1162 struct ignoretab {
1163    int         i_count;       /* Number of entries */
1164    struct ignore {
1165       struct ignore  *i_link;    /* Next ignored field in bucket */
1166       char           *i_field;   /* This ignored field */
1167    }           *i_head[HSHSIZE];
1168 };
1169
1170 /* Token values returned by the scanner used for argument lists.
1171  * Also, sizes of scanner-related things */
1172 enum ltoken {
1173    TEOL           = 0,        /* End of the command line */
1174    TNUMBER        = 1,        /* A message number */
1175    TDASH          = 2,        /* A simple dash */
1176    TSTRING        = 3,        /* A string (possibly containing -) */
1177    TDOT           = 4,        /* A "." */
1178    TUP            = 5,        /* An "^" */
1179    TDOLLAR        = 6,        /* A "$" */
1180    TSTAR          = 7,        /* A "*" */
1181    TOPEN          = 8,        /* An '(' */
1182    TCLOSE         = 9,        /* A ')' */
1183    TPLUS          = 10,       /* A '+' */
1184    TERROR         = 11,       /* A lexical error */
1185    TCOMMA         = 12,       /* A ',' */
1186    TSEMI          = 13,       /* A ';' */
1187    TBACK          = 14        /* A '`' */
1188 };
1189
1190 #define REGDEP          2     /* Maximum regret depth. */
1191
1192 /* Constants for conditional commands.  These describe whether we should be
1193  * executing stuff or not */
1194 enum condition {
1195    COND_ANY       = 0,        /* Execute in send or receive mode */
1196    COND_RCV       = 1,        /* Execute in receive mode only */
1197    COND_SEND      = 2,        /* Execute in send mode only */
1198    COND_TERM      = 3,        /* Execute only if stdin is a tty */
1199    COND_NOTERM    = 4,        /* Execute only if stdin not tty */
1200    COND_EXEC      = 5,        /* Do execute this block */
1201    COND_NOEXEC    = 6         /* Don't execute this block */
1202 };
1203
1204 /* For the 'shortcut' and 'unshortcut' functionality */
1205 struct shortcut {
1206    struct shortcut *sh_next;  /* next shortcut in list */
1207    char        *sh_short;     /* shortcut string */
1208    char        *sh_long;      /* expanded form */
1209 };
1210
1211 /* Kludges to handle the change from setexit / reset to setjmp / longjmp */
1212 #define setexit()       (void)sigsetjmp(srbuf, 1)
1213 #define reset(x)        siglongjmp(srbuf, x)
1214
1215 /* Content-Transfer-Encodings as defined in RFC 2045:
1216  * - Quoted-Printable, section 6.7
1217  * - Base64, section 6.8 */
1218
1219 #define QP_LINESIZE     (4 * 19)       /* Max. compliant QP linesize */
1220
1221 #define B64_LINESIZE    (4 * 19)       /* Max. compliant Base64 linesize */
1222 #define B64_ENCODE_INPUT_PER_LINE 57   /* Max. input for Base64 encode/line */
1223
1224 /* xxx QP came later, maybe rewrite all to use mimecte_flags directly? */
1225 enum __mimecte_flags {
1226    MIMECTE_NONE,
1227    MIMECTE_SALLOC = 1<<0,     /* Use salloc(), not srealloc().. */
1228    /* ..result .s,.l point to user buffer of *_LINESIZE+[+[+]] bytes instead */
1229    MIMECTE_BUF    = 1<<1,
1230    MIMECTE_CRLF   = 1<<2,     /* (encode) Append "\r\n" to lines */
1231    MIMECTE_LF     = 1<<3,     /* (encode) Append "\n" to lines */
1232    /* (encode) If one of _CRLF/_LF is set, honour *_LINESIZE+[+[+]] and
1233     * inject the desired line-ending whenever a linewrap is desired */
1234    MIMECTE_MULTILINE = 1<<4,
1235    /* (encode) Quote with header rules, do not generate soft NL breaks? */
1236    MIMECTE_ISHEAD = 1<<5
1237 };
1238
1239 enum qpflags {
1240    QP_NONE        = MIMECTE_NONE,
1241    QP_SALLOC      = MIMECTE_SALLOC,
1242    QP_BUF         = MIMECTE_BUF,
1243    QP_ISHEAD      = MIMECTE_ISHEAD
1244 };
1245
1246 enum b64flags {
1247    B64_NONE       = MIMECTE_NONE,
1248    B64_SALLOC     = MIMECTE_SALLOC,
1249    B64_BUF        = MIMECTE_BUF,
1250    B64_CRLF       = MIMECTE_CRLF,
1251    B64_LF         = MIMECTE_LF,
1252    B64_MULTILINE  = MIMECTE_MULTILINE
1253 };
1254
1255 /* Locale-independent character classes */
1256 enum {
1257    C_CNTRL        = 0000,
1258    C_BLANK        = 0001,
1259    C_WHITE        = 0002,
1260    C_SPACE        = 0004,
1261    C_PUNCT        = 0010,
1262    C_OCTAL        = 0020,
1263    C_DIGIT        = 0040,
1264    C_UPPER        = 0100,
1265    C_LOWER        = 0200
1266 };
1267
1268 #define __ischarof(C, FLAGS)  \
1269    (asciichar(C) && (class_char[(uc_it)(C)] & (FLAGS)) != 0)
1270
1271 #define asciichar(c)    ((uc_it)(c) <= 0177)
1272 #define alnumchar(c)    __ischarof(c, C_DIGIT | C_OCTAL | C_UPPER | C_LOWER)
1273 #define alphachar(c)    __ischarof(c, C_UPPER | C_LOWER)
1274 #define blankchar(c)    __ischarof(c, C_BLANK)
1275 #define blankspacechar(c) __ischarof(c, C_BLANK | C_SPACE)
1276 #define cntrlchar(c)    __ischarof(c, C_CNTRL)
1277 #define digitchar(c)    __ischarof(c, C_DIGIT | C_OCTAL)
1278 #define lowerchar(c)    __ischarof(c, C_LOWER)
1279 #define punctchar(c)    __ischarof(c, C_PUNCT)
1280 #define spacechar(c)    __ischarof(c, C_BLANK | C_SPACE | C_WHITE)
1281 #define upperchar(c)    __ischarof(c, C_UPPER)
1282 #define whitechar(c)    __ischarof(c, C_BLANK | C_WHITE)
1283 #define octalchar(c)    __ischarof(c, C_OCTAL)
1284
1285 #define upperconv(c)    (lowerchar(c) ? (char)((uc_it)(c) - 'a' + 'A') : (c))
1286 #define lowerconv(c)    (upperchar(c) ? (char)((uc_it)(c) - 'A' + 'a') : (c))
1287 /* RFC 822, 3.2. */
1288 #define fieldnamechar(c) \
1289    (asciichar(c) && (c) > 040 && (c) != 0177 && (c) != ':')
1290
1291 /* Try to use alloca() for some function-local buffers and data, fall back to
1292  * smalloc()/free() if not available */
1293 #ifdef HAVE_ALLOCA
1294 # define ac_alloc(n)    HAVE_ALLOCA(n)
1295 # define ac_free(n)     do {UNUSED(n);} while (0)
1296 #else
1297 # define ac_alloc(n)    smalloc(n)
1298 # define ac_free(n)     free(n)
1299 #endif
1300
1301 /* Single-threaded, use unlocked I/O */
1302 #ifdef HAVE_PUTC_UNLOCKED
1303 # undef getc
1304 # define getc(c)        getc_unlocked(c)
1305 # undef putc
1306 # define putc(c, f)     putc_unlocked(c, f)
1307 # undef putchar
1308 # define putchar(c)     putc_unlocked((c), stdout)
1309 #endif
1310
1311 /* Truncate a file to the last character written.  This is useful just before
1312  * closing an old file that was opened for read/write */
1313 #define ftrunc(stream) \
1314 do {\
1315    off_t off;\
1316    fflush(stream);\
1317    off = ftell(stream);\
1318    if (off >= 0)\
1319       ftruncate(fileno(stream), off);\
1320 } while (0)
1321
1322 /* fflush() and rewind() */
1323 #define fflush_rewind(stream) \
1324 do {\
1325    fflush(stream);\
1326    rewind(stream);\
1327 } while (0)
1328
1329 /* For saving the current directory and later returning */
1330 struct cw {
1331 #ifdef HAVE_FCHDIR
1332    int         cw_fd;
1333 #else
1334    char        cw_wd[MAXPATHLEN];
1335 #endif
1336 };
1337
1338 /*
1339  * Global variable declarations
1340  *
1341  * These become instantiated in main.c.
1342  */
1343
1344 #undef VL
1345 #ifdef _MAIN_SOURCE
1346 # ifndef HAVE_AMALGAMATION
1347 #  define VL
1348 # else
1349 #  define VL            static
1350 # endif
1351 #else
1352 # define VL             extern
1353 #endif
1354
1355 VL gid_t       effectivegid;        /* Saved from when we started up */
1356 VL gid_t       realgid;             /* Saved from when we started up */
1357
1358 VL int         mb_cur_max;          /* Value of MB_CUR_MAX */
1359 VL int         realscreenheight;    /* The real screen height */
1360 VL int         scrnwidth;           /* Screen width, or best guess */
1361 VL int         scrnheight;          /* Screen height/guess (4 header) */
1362 VL int         utf8;                /* Locale uses UTF-8 encoding */
1363 VL int         enc_has_state;       /* Encoding has shift states */
1364
1365 VL char        **altnames;          /* List of alternate names of user */
1366 VL char const  *homedir;            /* Path name of home directory */
1367 VL char const  *myname;             /* My login name */
1368 VL char const  *progname;           /* Our name */
1369 VL char const  *tempdir;            /* The temporary directory */
1370
1371 VL int         exit_status;         /* Exit status */
1372 VL int         options;             /* Bits of enum user_options */
1373 VL char        *option_r_arg;       /* Argument to -r option */
1374 VL char const  **smopts;            /* sendmail(1) opts from commline */
1375 VL size_t      smopts_count;        /* Entries in smopts */
1376
1377 /* TODO Join as many of these state machine bits into a single carrier! */
1378 VL int         inhook;              /* Currently executing a hook */
1379 VL bool_t      exec_last_comm_error; /* Last execute() command failed */
1380 VL bool_t      edit;                /* Indicates editing a file */
1381 VL bool_t      did_print_dot;       /* Current message has been printed */
1382 VL bool_t      list_saw_numbers;    /* Last *LIST saw numerics */
1383 VL bool_t      msglist_is_single;   /* Last NDMLIST/MSGLIST chose 1 msg */
1384 VL bool_t      loading;             /* Loading user definitions */
1385 VL bool_t      sourcing;            /* Currently reading variant file */
1386 VL bool_t      sawcom;              /* Set after first command */
1387 VL bool_t      starting;            /* Still in startup code */
1388 VL bool_t      var_clear_allow_undefined; /* v?ok_[bv]clear(): no complain */
1389 VL int         noreset;             /* String resets suspended */
1390
1391 /* XXX stylish sorting */
1392 VL int            msgCount;            /* Count of messages read in */
1393 VL enum condition cond_state;          /* State of conditional exc. */
1394 VL struct mailbox mb;                  /* Current mailbox */
1395 VL int            image;               /* File descriptor for msg image */
1396 VL char           mailname[MAXPATHLEN]; /* Name of current file */
1397 VL char           displayname[80 - 40]; /* Prettyfied for display */
1398 VL char           prevfile[MAXPATHLEN]; /* Name of previous file */
1399 VL char const     *account_name;       /* Current account name or NULL */
1400 VL off_t          mailsize;            /* Size of system mailbox */
1401 VL struct message *dot;                /* Pointer to current message */
1402 VL struct message *prevdot;            /* Previous current message */
1403 VL struct message *message;            /* The actual message structure */
1404 VL struct message *threadroot;         /* first threaded message */
1405 VL int            imap_created_mailbox; /* hack to get feedback from imap */
1406 VL int            msgspace;            /* Number of allocated struct m */
1407
1408 VL struct grouphead  *groups[HSHSIZE]; /* Pointer to active groups */
1409 VL struct ignoretab  ignore[2];        /* ignored and retained fields
1410                                         * 0 is ignore, 1 is retain */
1411 VL struct ignoretab  saveignore[2];    /* ignored and retained fields
1412                                         * on save to folder */
1413 VL struct ignoretab  allignore[2];     /* special, ignore all headers */
1414 VL struct ignoretab  fwdignore[2];     /* fields to ignore for forwarding */
1415 VL struct shortcut   *shortcuts;       /* list of shortcuts */
1416
1417 VL struct time_current  time_current;  /* time(3); send: mail1() XXXcarrier */
1418 VL struct termios_state termios_state; /* getpassword(); see commands().. */
1419
1420 #ifdef HAVE_COLOUR
1421 VL struct colour_table  *colour_table;
1422 #endif
1423
1424 #ifdef HAVE_SSL
1425 VL enum ssl_vrfy_level  ssl_vrfy_level; /* SSL verification level */
1426 #endif
1427
1428 #ifdef HAVE_ICONV
1429 VL iconv_t     iconvd;
1430 #endif
1431
1432 #ifdef HAVE_CATGETS
1433 VL nl_catd     catd;
1434 #endif
1435
1436 VL sigjmp_buf  srbuf;
1437 VL int         interrupts;
1438 VL sighandler_type dflpipe;
1439 VL sighandler_type handlerstacktop;
1440 #define handlerpush(f)  (savedtop = handlerstacktop, handlerstacktop = (f))
1441 #define handlerpop()    (handlerstacktop = savedtop)
1442
1443 VL char        *temporary_arg_v_store;
1444
1445 /* The remaining variables need initialization */
1446
1447 #ifndef HAVE_AMALGAMATION
1448 VL char const  month_names[12 + 1][4];
1449 VL char const  weekday_names[7 + 1][4];
1450
1451 VL char const  uagent[];            /* User agent */
1452 VL char const  version[];           /* The version string */
1453 VL char const  features[];          /* The "feature string" */
1454
1455 VL uc_it const class_char[];
1456 #endif
1457
1458 /*
1459  * Finally, let's include the function prototypes XXX embed
1460  */
1461
1462 #include "extern.h"
1463
1464 /* vim:set fenc=utf-8:s-it-mode */