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