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