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