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